travoltron / skeleton

A skeleton repository for Laravel Packages

:package_name

To use this skeleton

Create the directory that you'll be using to work in locally, cd into it and clone this package

$ mkdir directory && cd directory
$ git clone [email protected]:travoltron/skeleton.git .

Run the bulk updater

$ php prefill.php

Remove the references to this git repo

$ rm -rf .git*

Initialize a new git repo

$ git init
$ git add --all
$ git commit -m "first commit"
$ git remote add origin [email protected]::vendor/:package_name.git
$ git push -u origin master

This assumes you have created an empty repository at Github. Change to suit your own needs. -travoltron

Upload to packagist or include this package in your base Laravel app

For people hosting private packages on Github: you can add your token to Composer and include the packages like normal. You just need to tag the release and include this in your composer.json:

"require": {
  "php": ">=5.6.4",
  ":vendor/:package_name": "0.0.1"
},
"repositories": [
  {
    "type": "vcs",
    "url":  "[email protected]::vendor/:package_name.git"
  }
],

Include the Service Provider in your app

In the file config/app.php, find the 'providers' array and insert :Vendor\SkeletonClass\SkeletonServiceProvider::class.

Now the commands are registered, as well as the routes. If you plan on making a static class, you can add the :Skeleton class to the aliases array in the same file.

Description

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Install

Via Composer

$ composer require :vendor/:package_name

Usage

$skeleton = new League\Skeleton();
echo $skeleton->echoPhrase('Hello, League!');

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Credits

• :author_name
• All Contributors

License

The MIT License (MIT). Please see License File for more information.