zingle-com/laravel-modules

Adds Modules to Laravel.

Laravel Modules

, _(*1)

Simple helpers for adding modular architecture to your Laravel project., _(*2)

Overview

Modular architecture makes your application easier to understand and scale. This package attempts to add support for modules with minimal effort and greatest amount of flexibility. A Module in this package corresponds with a module grouping of code in your project., _(*3)

Installation

Install the base package with composer., _(*4)

~~~ bash $ composer install zingle-com/laravel-modules, _(*5)

Add service provider to your providers after the Illuminate providers, 
but before your project service providers.

~~~ php
// config.php
// ...
    'providers' => [
        // ...
        Illuminate\Validation\ValidationServiceProvider::class,
        Illuminate\Session\SessionServiceProvider::class,
        Illuminate\Notifications\NotificationServiceProvider::class,

        /**
         * Vendors
         */
        // ...
        ZingleCom\LaravelModules\ModuleServiceProvider::class,

        // ...
        /**
         * Project providers
         */
    ],

Finally install the vendor assets:, _(*6)

~~~ bash $ php artisan vendor:publish --provider="ZingleCom\LaravelModules\ModuleServiceProvider::class", _(*7)

# Usage

After defining your modular structure, to create a new module simply 
create add a new class that extends `Module` to your base module 
directory that corresponds with the name of the module. For example,
if you had a module named `Auth` the base directory for which is
`app/Modules/Auth` you would create the following class:

~~~ php
namespace App\Modules\Auth;

use ZingleCom\LaravelModules\Module\Module;

class AuthModule extends Module
{

}

Then add the new module class to config/modules.php under the modules key like:, _(*8)

~~~ php // modules.php // .. "modules" => [ App\Modules\Auth\AuthModule::class, ], ~~~, _(*9)