akaunting/module

Module management package for Laravel.

1.0.0 2019-04-11 19:07 UTC

README

Version Downloads Build Status StyleCI Quality License

This package intends to make your Laravel app extendible via modules. A module is kinda small Laravel app, shipping with its own views, controllers, models etc.

Getting Started

1. Install

Run the following command:

composer require akaunting/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

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see LICENSE for more information.