├── src
    ├── lang
    │   └── .gitkeep
    ├── views
    │   └── .gitkeep
    ├── assets
    │   └── .gitkeep
    ├── database
    │   ├── seeds
    │   │   └── .gitkeep
    │   └── migrations
    │   │   └── .gitkeep
    ├── routes
    │   └── routes.php
    ├── config
    │   └── config.php
    └── Package
    │   ├── Commands
    │       └── FooCommand.php
    │   └── PackageServiceProvider.php
├── tests
    ├── .gitkeep
    ├── PackageTestCase.php
    ├── Unit
    │   └── ExampleTest.php
    └── Feature
    │   └── ExampleTest.php
├── .gitignore
├── .travis.yaml
├── phpunit.xml
├── composer.json
└── README.md


/src/lang/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/src/views/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/tests/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/src/assets/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/src/database/seeds/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/src/database/migrations/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | composer.phar
3 | composer.lock
4 | .DS_Store
5 | 


--------------------------------------------------------------------------------
/src/routes/routes.php:
--------------------------------------------------------------------------------
1 | <?php 
2 | 
3 | /**
4 |  * You may define custom routes for your package here
5 |  */


--------------------------------------------------------------------------------
/src/config/config.php:
--------------------------------------------------------------------------------
 1 | <?php 
 2 | 
 3 | return [
 4 |     
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Package Configuration Option
 8 |     |--------------------------------------------------------------------------
 9 |     | Describe what it does. 
10 |     */
11 | 
12 |     //'key' => 'value',
13 | 
14 | ];
15 | 


--------------------------------------------------------------------------------
/tests/PackageTestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vendor\Package\Tests;
 4 | 
 5 | use Vendor\Package\PackageServiceProvider;
 6 | use Orchestra\Testbench\TestCase;
 7 | 
 8 | abstract class PackageTestCase extends TestCase
 9 | {
10 | 
11 |     protected function getPackageProviders($app)
12 |     {
13 |         return [PackageServiceProvider::class];
14 |     }
15 | }
16 | 


--------------------------------------------------------------------------------
/tests/Unit/ExampleTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vendor\Packages\Tests\Unit;
 4 | 
 5 | use Vendor\Package\Tests\PackageTestCase;
 6 | 
 7 | class ExampleTest extends PackageTestCase
 8 | {
 9 |     /**
10 |      * A basic test example.
11 |      *
12 |      * @return void
13 |      */
14 |     public function testBasicTest()
15 |     {
16 |         $this->assertTrue(true);
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/tests/Feature/ExampleTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vendor\Packages\Tests\Feature;
 4 | 
 5 | use Vendor\Package\Tests\PackageTestCase;
 6 | 
 7 | class ExampleTest extends PackageTestCase
 8 | {
 9 |     /**
10 |      * A basic test example.
11 |      *
12 |      * @return void
13 |      */
14 |     public function testBasicTest()
15 |     {
16 |         $this->assertTrue(true);
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/.travis.yaml:
--------------------------------------------------------------------------------
 1 | language: php
 2 | 
 3 | php:
 4 |   - 7.0
 5 |   - 7.1
 6 |   - 7.2
 7 | 
 8 | env:
 9 |   - LARAVEL_VERSION=5.5.*  
10 |   - LARAVEL_VERSION=5.6.*
11 | 
12 | matrix:
13 |   fast_finish: true
14 |   exclude:    
15 |     - php: 7.0      
16 |       env: LARAVEL_VERSION=5.6.*
17 | 
18 | before_script:
19 |   - travis_retry composer self-update
20 |   - travis_retry composer install --prefer-source --no-interaction         
21 |   - if [ "$LARAVEL_VERSION" != "" ]; then composer require --dev "laravel/laravel:${LARAVEL_VERSION}" --no-update; fi;  
22 |   - composer update
23 | 
24 | script:
25 |   - phpunit


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit backupGlobals="false"
 3 |          backupStaticAttributes="false"
 4 |          colors="true"
 5 |          convertErrorsToExceptions="true"
 6 |          convertNoticesToExceptions="true"
 7 |          convertWarningsToExceptions="true"
 8 |          processIsolation="false"
 9 |          stopOnFailure="false"
10 |          syntaxCheck="false"
11 |          bootstrap="./vendor/autoload.php"
12 | >
13 |     <testsuites>
14 |         <testsuite name="Package Test Suite">
15 |             <directory suffix=".php">./tests</directory>
16 |         </testsuite>
17 |     </testsuites>
18 | </phpunit>
19 | 


--------------------------------------------------------------------------------
/src/Package/Commands/FooCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Vendor\Package\Commands;
 4 | 
 5 | use Illuminate\Console\Command;
 6 | 
 7 | class FooCommand extends Command
 8 | {
 9 |     /**
10 |      * The name and signature of the console command.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $signature = 'package:foo';
15 | 
16 |     /**
17 |      * The console command description.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $description = '';
22 | 
23 |     /**
24 |      * Create a new command instance.
25 |      *
26 |      * @return void
27 |      */
28 |     public function __construct()
29 |     {
30 |         //
31 |     }
32 | 
33 |     /**
34 |      * Execute the console command.
35 |      *
36 |      * @return mixed
37 |      */
38 |     public function handle()
39 |     {
40 |         //
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "vendor/package",
 3 |     "description": "",
 4 |     "keywords": [],
 5 |     "homepage": "",
 6 |     "authors": [
 7 |         {
 8 |             "name": "",
 9 |             "email": ""
10 |         }
11 |     ],
12 |     "require": {
13 |         "illuminate/support": "5.5.*|5.6.*"
14 |     },
15 |     "require-dev": {
16 |         "phpunit/phpunit": "6.0.*|7.0.*",
17 |         "orchestra/testbench": "3.5.*|3.6.*"
18 |     },
19 |     "autoload": {
20 |        "psr-4": {
21 |             "Vendor\\Package\\": "src/Package"
22 |         }
23 |     },
24 |     "autoload-dev": {
25 |         "psr-4": {
26 |             "Vendor\\Package\\Tests\\": "tests/"
27 |         }
28 |     },
29 |     "extra": {
30 |         "laravel": {
31 |             "providers": [
32 |                 "Vendor\\Package\\ServiceProvider"
33 |             ]
34 |         }
35 |     },
36 |     "license": "MIT"
37 |     
38 | }
39 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel 5's Package Boilerplate
 2 | 
 3 | A custom made Laravel5 package boilerplate made for package development purpose, which contains publish code for :
 4 | 
 5 | - Config
 6 | - View
 7 | - Assets
 8 | - Migrations
 9 | - Seeds
10 | - Routes
11 | 
12 | ## Usage
13 | 
14 | 1- Clone this repository into your package development folder.
15 | 
16 | 2- Change src/Package to your package name. Customize the package's composer.json autoload section to reflect the previous change.
17 | 
18 | 3- Customize **Package/PackageServiceProvider** with the correct namespace and the name of your package, and replace the $packageName attribute.
19 | 
20 | ```php
21 | 
22 |     protected $packageName = 'yourpackagename';
23 | 
24 | ```
25 | 
26 | 4- Add the package in your application's **composer.json** autoload section to make it available in your application. 
27 | 
28 | ```
29 | 
30 | "psr-4": {
31 |             "App\\": "app/",
32 |             "Vendor\\Package\\": "packages/vendor/package/src/Package"
33 |         }
34 | 
35 | ```
36 | 
37 | 5- Run :
38 | 
39 | ```
40 | composer dump-autoload
41 | ```
42 | 
43 | 6- Add the newly create package's service provider to your **config/app.php** provider's list.
44 | 
45 | 7- Have fun!
46 | 
47 | ## Package dependencies
48 | 
49 | Laravel won't autoload the **vendor/** path in your package's development folder. Easiest workaround is to add them in your main application's composer.json.
50 | 


--------------------------------------------------------------------------------
/src/Package/PackageServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php 
 2 | 
 3 | namespace Vendor\Package;
 4 | 
 5 | use Illuminate\Support\ServiceProvider;
 6 | use Vendor\Package\Commands\FooCommand;
 7 | 
 8 | /**
 9 |  * A Laravel 5.5 package boilerplate
10 |  *
11 |  * @author: Rémi Collin (remi@code16.fr)
12 |  */
13 | class PackageServiceProvider extends ServiceProvider {
14 | 
15 |     /**
16 |      * This will be used to register config & view in 
17 |      * your package namespace.
18 |      *
19 |      * --> Replace with your package name <--
20 |      * 
21 |      * @var  string
22 |      */
23 |     protected $packageName = 'package';
24 | 
25 |     /**
26 |      * A list of artisan commands for your package
27 |      * 
28 |      * @var array
29 |      */
30 |     protected $commands = [
31 |         FooCommand::class,
32 |     ];
33 | 
34 |     /**
35 |      * Bootstrap the application services.
36 |      *
37 |      * @return void
38 |      */
39 |     public function boot()
40 |     {
41 |         $this->loadRoutesFrom(__DIR__.'/../routes/routes.php');
42 | 
43 |         // Register Views from your package
44 |         $this->loadViewsFrom(__DIR__.'/../views', $this->packageName);
45 | 
46 |         // Regiter migrations
47 |         $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
48 | 
49 |         // Register translations
50 |         $this->loadTranslationsFrom(__DIR__.'/../lang', $this->packageName);
51 |         $this->publishes([
52 |             __DIR__.'/../lang' => resource_path('lang/vendor/'. $this->packageName),
53 |         ]);
54 | 
55 |         // Register your asset's publisher
56 |         $this->publishes([
57 |             __DIR__.'/../assets' => public_path('vendor/'.$this->packageName),
58 |         ], 'public');
59 | 
60 |         // Publish your seed's publisher
61 |         $this->publishes([
62 |             __DIR__.'/../database/seeds/' => base_path('/database/seeds')
63 |         ], 'seeds');
64 | 
65 |         // Publish your config
66 |         $this->publishes([
67 |             __DIR__.'/../config/config.php' => config_path($this->packageName.'.php'),
68 |         ], 'config');
69 | 
70 |         if ($this->app->runningInConsole()) {
71 |             $this->commands($this->commands);
72 |         }
73 |     }
74 | 
75 |     /**
76 |      * Register the application services.
77 |      *
78 |      * @return void
79 |      */
80 |     public function register()
81 |     {
82 |         $this->mergeConfigFrom(
83 |             __DIR__.'/../config/config.php', $this->packageName
84 |         );
85 | 
86 |     }
87 | 
88 | }
89 | 


--------------------------------------------------------------------------------