Insular is a software architecture to build scalable Laravel projects in a modern, clear and modular way.
Insular is latin word which means "Having a narrow view of the world." and that is how modules are suppose to be structured. 🔥🔥
- Installation
- Snowflake
- Available commands
- Managing Modules
- Managing Features
- Managing Operations
- Managing Jobs
- Managing Controllers
- Managing Migrations
- Managing Models
- Managing Resources
- Managing Requests
- Managing Types
- Managing Exception
You can install the package via composer:
composer require MagedAhmad/insularWe use snowflake for ids, by default newly created models with the custom command will use the Snowflake trait. you can read more about snowflake here
| Target | Command |
|---|---|
| Create new module | php artisan create:module $name |
| Create new feature | php artisan create:feature $name $module |
| Create new operation | php artisan create:operation $name $module |
| Create new job | php artisan create:job $name $module |
| Create new controller | php artisan create:controller $name $module |
| Create new migration | php artisan create:migration $name $module |
| Create new model | php artisan create:model $name $module |
| Create new type | php artisan create:type $name $module |
| Create new resource | php artisan create:resource $name $module |
| Create new request | php artisan create:request $name $module |
| Create new exception | php artisan create:exception $name $module |
You start by building the main block in your application which is a Module.
Modules are like mini laravel applications where each module contains everything needed to build this module.
php artisan create:module $name example:
php artisan create:module Auththis will create module structure in Modules\Auth
Feature can be used when you have multiple operations related to some action and you would repeat these operations more than once, so you can create a feature and reuse it later on.
php artisan create:feature $name $module example:
php artisan create:feature LoginUserFeature Auththis will create feature in Modules\Auth\Features\LoginUserFeature
Operation is the main building block where most logic would go, it might contain multiple jobs.
php artisan create:operation $name $moduleexample:
php artisan create:operation LoginUserOperation Auth
this will create file in Modules\Auth\Operations\LoginUserOperation
Jobs are the smallest unit on our system. you can use it to avoid duplication of small shrunks of code . you should only use it when you are sure that you would use it multiple times, otherwise operation should be just fine to hold the logic in it.
php artisan create:job $name $moduleexample:
php artisan create:job LoginUserJob Auth
this will create file in Modules\Auth\Jobs\LoginUserJob
php artisan create:controller $name $moduleexample:
php artisan create:controller LoginController Auth
this will create file in Modules\Auth\Http\Controllers\LoginController
you only need to write the migration name like users, products, categories, no need to type create_users_table .
php artisan create:migration $name $moduleexample:
php artisan create:migration users Auth
this will create file in Modules\Auth\database\migrations\users
Models use snowflake trait by default
php artisan create:model $name $moduleexample:
php artisan create:model User Auth
this will create file in Modules\Auth\Models\User
Resources can be used to map data before sending in the response .
php artisan create:resource $name $moduleexample:
php artisan create:resource UserResource Auth
this will create file in Modules\Auth\Http\Controllers\Resource\UserResource
can be used for validating incoming request data .
php artisan create:request $name $moduleexample:
php artisan create:request UserRequest Auth
this will create file in Modules\Auth\Http\Controllers\Requests\UserRequest
Types can be used for internal handling of data between classes
php artisan create:type $name $moduleexample:
php artisan create:type UserData Auth
this will create file in Modules\Auth\Types\UserData
php artisan create:exception $name $moduleexample:
php artisan create:exception UserNotFoundException Auth
this will create file in Modules\Auth\Exceptions\UserNotFoundException
vendor/bin/pest 1- Work on a global response for all requests. 2- Provide easy way to test/view apis. 3- Switch between Pest and phpunit
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.