agenter-labs / laravel-module
Module management package for Laravel
Requires
- php: >=7.3
Requires (Dev)
- friendsofphp/php-cs-fixer: >=2.16
- laravel/framework: ^8.0
- mockery/mockery: >=1.0
- orchestra/testbench: >=6.0
- phpstan/phpstan: >=0.12.14
- phpunit/phpunit: >=8.5
- spatie/phpunit-snapshot-assertions: >=2.1.0
README
This package intends to make your Laravel app extensible via modules. A module is a kinda small Laravel app, shipping with its own views, controllers, models, etc.
Getting Started
1. Install
Run the following command:
composer require akaunting/laravel-module
2. Register
Service provider and facade will be registered automatically. If you want to register them manually in config/app.php
:
Akaunting\Module\Facade::class, Akaunting\Module\Providers\Laravel::class,
3. Publish
Publish config file.
php artisan vendor:publish --tag=module
4. Configure
You can change the configuration from config/module.php
file
5. Autoloading
By default, the module classes are not loaded automatically. You can autoload your modules using psr-4
. For example:
{ "autoload": { "psr-4": { "App\\": "app/", "Modules\\": "modules/" } } }
Tip: don't forget to run composer dump-autoload
afterwards.
Usage
Check out the wiki about the usage and further documentation.
Changelog
Please see Releases for more information what has changed recently.
Contributing
Pull requests are more than welcome. You must follow the PSR coding standards.
Credits
License
The MIT License (MIT). Please see LICENSE for more information.