neelkanthk/larapackboiler

Laravel 5.1+ package development boilerplate.

Laravel Package Boilerplate

Version 1.0.0

A package development boilerplate for Laravel 5.1+

Download https://github.com/neelkanthk/TodoPackage for a demo package built using LaraPackBoiler.

Provides a Jump Start to your Laravel package development in a structured way.

Salient Features

• Follows Laravel 5.1 directory structure.
• Well documented with example code.
• Encourages use of Interfaces and Database Repositories.
• Saves a lot of time while developing a new package from scratch.
• Make your package views customizable in the application.
• Provides example code for controller, model, view, interfaces, events, repositories.
• Helps in learning Package Development.

Installation

Note: You need to have composer installed on your system., _(*1)

1. Download this package to your vendor folder., _(*2)

   composer require neelkanthk/larapackboiler "dev-master"
   

2. Copy the following to your config/app.php's providers array, _(*3)

• Package\Application\Providers\PackageServiceProvider::class
• Package\Application\Providers\PackageEventServiceProvider::class

1. Change the larapackboiler composer.json file to define dependencies and other package related information., _(*4)

2. Add the following line to the project's composer.json psr-4 array:, _(*5)

   "psr-4": {
             "App\\": "app/",
             "Package\\Application\\" : "vendor/neelkanthk/larapackboiler/application/src/"
         }
   

3. Run composer dumpautoload or composer dump-autoload from your project root., _(*6)

4. Run following command to move the package assets, views, config files to your application folder. (Optional), _(*7)

   php artisan vendor:publish
   

5. Test your installation by visiting the following URL in your browser., _(*8)

   packagename/test, _(*9)

6. If you see 'Hi I am PackageController@exampleAction', then you have successfully configured the laraPackBoiler., _(*10)

7. That's it. Now, You are ready to develop your package., _(*11)

The boilerplate code is well documented to help you in your development.

Quick Start for developing your first package using boilerplate

1. Rename the package folder to your package name.

2. Change the package name in project's composer.json psr-4 array., _(*12)

   Example:, _(*13)

   "psr-4": {
             "App\\": "app/",
             "TodoPackage\\Application\\" : "vendor/{path_to_package}/application/src/"
         }
   

3. Similarly, Change the package name in your config/app.php's providers array.

• TodoPackage\Application\Providers\TodoPackageServiceProvider::class
• TodoPackage\Application\Providers\TodoPackageEventServiceProvider::class

1. Change the package's composer.json psr-4 array:, _(*14)

   "psr-4": {
           "todopackage\\application\\": "src/"
       }
   

2. Run composer dump-autoload from your project root., _(*15)

3. Done. Start adding new controllers, models, routes, views to your new package., _(*16)