expstudio/lumen-modules

v5.0.1 2017-08-31 03:27 UTC

README

Expstudio Modules

Lumen 5.4 Source License

Expstudio Modules is a simple package to allow the means to separate your Lumen 5.4 application out into modules. Each module is completely self-contained allowing the ability to simply drop a module in for use.

The package follows the FIG standards PSR-1, PSR-2, and PSR-4 to ensure a high level of interoperability between shared PHP code.

Documentation

You will find user friendly and updated documentation in the wiki here: Caffeinated Modules Wiki

Quick Installation

Begin by installing the package through Composer.

composer require expstudio/lumen-modules

Once this operation is complete, simply add both the service provider and facade classes to your project's bootstrap/app.php file:

Service Provider

$app->register(Expstudio\Modules\ModulesServiceProvider::class);

Facade


$app->withFacades(true, [Expstudio\Modules\Facades\Module::class => 'Module']);

And that's it! With your coffee in reach, start building out some awesome modules!

Add Module

$app->register(App\Modules\[ModuleName]\Providers\ModuleServiceProvider::class);