rodrigobutta/laravel-attachable-modules

Make your project scalable with isolated modules

Laravel Attachable Modules

Make your project scalable with isolated modules, _(*1)

How it works

A project will be made of modules, for example, you may want a Products module and a Users module, in wich case your project structure will have this: \App\Modules\Project**** \App\Modules\User****, _(*2)

Where Project an User are the respective folders for each module and will contain every needed file inside (no file should be spread outside this folder besides config or database matter files), _(*3)

Inside every module folder, there should be a Service Provider that we will call Boot Service Provider. The boot service provider file is where a module is defined, with its namespaces, views, configs, langs, etc., _(*4)

Laravel Attachable Modules will search for every Boot Service Provider file and use it to load every module to the project. Please refer to the config file to set this logic up (if you wont be usign the default one)., _(*5)

Theres a demo module inside this package ("demos") that has the needed structure and works with RodrigoButta/laravel-admin for handling the backend in a bunch of lines. But of course you can get rid of that and user the module like a boilerplate., _(*6)

Installation

composer.json:, _(*7)

"require": {
  "rodrigobutta/laravel-attachable-modules": ">=1.0.0",
}

terminal:, _(*8)

composer update

config/app.php:, _(*9)

'providers' => [
    [...]
    RodrigoButta\AttachableModules\AttachableModulesServiceProvider::class

],

terminal:, _(*10)

php artisan vendor:publish

config/attachable-modules.php, _(*11)

• modules_folder_path: path where modules are located (each module should have its own folder, with the boot provider and any files it needs to run)
• module_boot_provider_prefix: expected prefix for the boot service provider file
• module_boot_provider_suffix: expected suffix for the boot service provider file (without the .php extension)

Adding a module

So easy!, _(*12)

1) Copy the module folder inside app\Modules\ (or the folder you've defined for storing modules), _(*13)

2) terminal:, _(*14)

composer dump-autoload

3) The module is now beign called. Depending on the module architecture, you should know how to test or acces its funcions., _(*15)