codeurx/modular

Codeurx Modular is simply a package for Laravel to help you create and manage modules.

Codeurx Modular

, _(*1)

Codeurx Modular is simply a package for Laravel to help you create and manage modules., _(*2)

Install

To install through Composer, by run the following command:, _(*3)

``` bash composer require codeurx/modular, <sub>(*4)</sub>

### Autoloading

By default the module classes are not loaded automatically. You can autoload your modules using `psr-4`. For example:

``` json
{
  "autoload": {
    "psr-4": {
      "App\\": "app/",
      "App\\Modules\\": "app/Modules/"
    },
    "files": [
        "app/Modules/helpers/helpers.php"
    ]
  }
}

Tip: don't forget to run composer dump-autoload afterwards., <sub>(*5)</sub>

run the following command to publish modules table migrations:, <sub>(*6)</sub>

php artisan vendor:publish --provider="Codeurx\Modular\ModularServiceProvider" --tag="migrations"

after that run the command:, <sub>(*7)</sub>

php artisan migrate

Usage

Creating A Module, <sub>(*8)</sub>

To create a new module, simply run the following command: ``` bash php artisan modular:make , <sub>(*9)</sub>

- `<module-name>` - Replace with the name of the desired module.

**Folder Structure**

app/Modules/ ├── Users/ ├─ Database/ ├─ Migrations/ ├─ Http/ ├─ Controllers/ ├─ UsersController.php ├─ Models/ ├─ UsersModel.php ├─ Providers/ ├─ UsersServiceProvider.php ├─ Resources/ ├─ views/ ├─ index.blade.php ├─ Routes/ ├─ web.php, <sub>(*10)</sub>

You can access the url example for Users module by typing :

http://sever/users/ or http://sever/public/users/, <sub>(*11)</sub>

For Dummy data:

http://sever/users/users-test or http://sever/public/users/users-test, <sub>(*12)</sub>

**Deleting A Module**

To delete a specific module, simply run the following command:
``` bash
php artisan modular:delete <module-name>

• <module-name> - Replace with the name of the desired module to be deleted.

Tip: if the module does not exist you will be asked if you want to create it., <sub>(*13)</sub>

Listing All the Modules, <sub>(*14)</sub>

To list the modules just run the following command:, <sub>(*15)</sub>

``` bash php artisan modular:list, <sub>(*16)</sub>

**Creating A Module Migration**

To create a migration for a specific module just run the following command:

``` bash
php artisan modular:make-migration <module-name> --table=<table-name>

• <module-name> - Replace with the name of the desired module.
• <table-name> - optional field, replace it with a disired name of table.

if you don't give the option --table the table name will take the name of the module by default., <sub>(*17)</sub>

Migrating Database for all modules, <sub>(*18)</sub>

bash php artisan modular:migrate, <sub>(*19)</sub>

Migrating Database for specific module, <sub>(*20)</sub>

bash php artisan modular:migrate <module-name>, <sub>(*21)</sub>

Creating a new Controller for specific module, <sub>(*22)</sub>

bash php artisan modular:make-controller <module-name> <controller-name>, <sub>(*23)</sub>

• <module-name> - Replace with the name of the desired module.
• <controller-name> - Replace with the controller name.

For example :, <sub>(*24)</sub>

bash php artisan modular:make-controller users TestController or, <sub>(*25)</sub>

bash php artisan modular:make-controller users Test/TestController Tip: if you typed the second command the folder structure will be like below :, <sub>(*26)</sub>

app/Modules/
      ├── Users/
          ├─ Database/
             ├─ Migrations/
          ├─ Http/
             ├─ Controllers/
                ├─ Test 
                   ├─ TestController.php
                ├─ UsersController.php
             ├─ Models/
                ├─ UsersModel.php
          ├─ Providers/
             ├─ UsersServiceProvider.php
          ├─ Resources/
             ├─ views/
                ├─ index.blade.php
          ├─ Routes/
             ├─ web.php 

And for the routes you should add a line like this :, <sub>(*27)</sub>

<?php

/*
|--------------------------------------------------------------------------
| Users Module Routes
|--------------------------------------------------------------------------
|
| All the routes related to the Users module have to go in here. 
|
*/

Route::get('/', 'UsersController@index');
Route::get('/users-test', 'UsersController@UsersTest');
Route::get('/test', 'Test\TestController@index');

Creating a new model for specific module, <sub>(*28)</sub>

bash php artisan modular:make-model <module-name> <model-name>, <sub>(*29)</sub>

• <module-name> - Replace with the name of the desired module.
• <model-name> - Replace with the model name.

For example :, <sub>(*30)</sub>

bash php artisan modular:make-model users TestModel or, <sub>(*31)</sub>

bash php artisan modular:make-model users Test/TestModel Tip: if you typed the second command the folder structure will be like below :, <sub>(*32)</sub>

app/Modules/
      ├── Users/
          ├─ Database/
             ├─ Migrations/
          ├─ Http/
             ├─ Controllers/
                ├─ UsersController.php
             ├─ Models/
                ├─ Test 
                   ├─ TestModel.php
                ├─ UsersModel.php
          ├─ Providers/
             ├─ UsersServiceProvider.php
          ├─ Resources/
             ├─ views/
                ├─ index.blade.php
          ├─ Routes/
             ├─ web.php 

Credits

• Amir Ali Salah

About Amir Ali Salah

I'm a Tunisian FullStack Web Developer. For the moment i work for GIS (Gate Informatic Systems), you can visit My Website for more Informations., <sub>(*33)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*34)</sub>