zwarthoorn/admin

Catagory module

Boilerplate Laravel 5 Package

Installation

Clone this repo with minimal history:, _(*1)

git clone --depth 1 git@github.com:cviebrock/laravel5-package-template.git

Rename the directory and re-init it as your own package:, _(*2)

mv laravel5-package-template my-package
cd my-package
rm -rf .git
git init

Configuration

The boilerplate files provide a scaffold for building your own package. You'll need to make a bunch of changes to the files we've provided to make it your own., _(*3)

composer.json

Edit composer.json to reflect your package information. At a minimum, you will need to change the package name and autoload lines so that "vendor/package" reflects your new package's name and namespace., _(*4)

{
    "name": "vendor/package",
    ...
    "autoload": {
        "psr-4": {
            "Vendor\\Package\\": "src/"
        }
    },
    ...
},

config/packagename.php

Rename config/packagename.php to something more useful, like config/my-package.php. This is the configuration file that Laravel will publish into it's config directory. Laravel 5 doesn't use the config/packages/vendor/... structure that Laravel 4 did, so pick a file name that's not likely to conflict with existing configuration files., _(*5)

src/ServiceProvider.php

Open up src/ServiceProvider.php as well. At a minimum you'll need to change the namespace at the top of the file (it needs to match the PSR-4 namespace you set in composer.json)., _(*6)

In the boot() method, comment out or uncomment the components your package will need. For example, if your package only has a configuration, then you can comment out everything except the handleConfigs() call:, _(*7)

public function boot() {
    $this->handleConfigs();
    // $this->handleMigrations();
    // $this->handleViews();
    // $this->handleTranslations();
    // $this->handleRoutes();
}

In the handleConfigs() method, you'll want to change the "packagename" references to the name you chose up above (in the [config/packagename.php] instructions)., _(*8)

For the other methods, again change instances of "vendor" and "packagename" to your package's name., _(*9)

Last Steps

Update the LICENSE file as required (make sure it matches what you said your package's license is in composer.json)., _(*10)

Finally, edit this README.md file and replace it with a description of your own, awesome Laravel 5 package., _(*11)

Commit everything to your (newly initialized) git repo, and push it wherever you'll keep your package (Github, etc.)., _(*12)

Enjoy coding!, _(*13)