Download the PHP package uncover/modular-monolith-laravel without Composer
On this page you can find all versions of the php package uncover/modular-monolith-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download uncover/modular-monolith-laravel
More information about uncover/modular-monolith-laravel
Files in uncover/modular-monolith-laravel
Package modular-monolith-laravel
Short Description Modular monolith architecture scaffolding for Laravel
License MIT
Informations about the package modular-monolith-laravel
Laravel Modular Monolith Package
A Laravel package that provides scaffolding for building modular monolith applications with standardized CRUD patterns, UUID support, and automatic route registration.
Features
- One Command Module Generation: Generate Controller, Model, Validation, Middleware, Service, and Observer with a single artisan command
- Base Classes with Full CRUD: Pre-built base classes with complete CRUD operations (create, read, update, delete, query)
- Route Macro:
Route::moduleResource()for automatic REST endpoint registration - UUID Support: Automatic UUID generation and handling
- Batch Operations: Built-in support for batch create and delete
- Flexible Validation: Per-action validation rules (create, read, update, delete, query)
- Service Layer: Base service with caching, transaction support, and query methods
- Observers: Base observer for model lifecycle events
- Publishable Base Classes: Customize base classes if needed
Requirements
- PHP 8.0+
- Laravel 9.0, 10.0, or 11.0
Installation
The package will auto-register its service provider.
Quick Start
1. Generate a Module
This creates:
app/Http/Controllers/EmailVerificationController.php- ExtendsModularControllerapp/Models/EmailVerification.php- ExtendsModularModelapp/Validations/EmailVerificationValidation.php- ExtendsModularValidationapp/Http/Middleware/EmailVerificationMiddleware.php- ExtendsModularMiddlewareapp/Services/EmailVerificationService.php- ExtendsModularServiceapp/Observers/EmailVerificationObserver.php- ExtendsModularObserverdatabase/migrations/xxxx_xx_xx_create_email_verifications_table.php(with --migration)
2. Add Routes
In your routes/api.php:
The moduleResource macro automatically creates:
POST /email-verifications→createGET /email-verifications→queryGET /email-verifications/{id}→readPATCH /email-verifications/{id}→updateDELETE /email-verifications/{id?}→delete
Command Options
| Option | Description |
|---|---|
--controller |
Generate a controller (default: true) |
--model |
Generate a model (default: true) |
--validation |
Generate a validation class |
--middleware |
Generate a middleware class |
--service |
Generate a service class |
--observer |
Generate an observer class |
--migration |
Create a migration file |
--all |
Generate all components |
--force |
Overwrite existing files |
Configuration
Publish the config file:
Available Options
Publishing Base Classes
If you want to customize the base classes:
This publishes all base classes to your app, allowing you to override and customize them.
Base Classes
ModularController
The base controller provides these methods:
create(Request $request)- Create single or batch recordsread(string $id)- Get a single record by UUIDupdate(Request $request, string $id)- Update a recorddelete(Request $request, ?string $id = null)- Delete single or batchquery(Request $request)- List with filtering, sorting, pagination
Query Parameters
The query method supports:
- Pagination:
?per_page=25 - Sorting:
?sort_by=created_at&sort_order=desc - Filtering:
?filter[status]=active - Search:
?search=john&search_fields=name,email - Eager Loading:
?include=author,comments
Generated Controller
ModularModel
The base model includes:
- UUID primary key (
uuidcolumn) - HasUuids trait for automatic UUID generation
- Soft deletes support
- Route key by UUID
Generated Model
ModularValidation
Base validation class with action-based rules:
ModularMiddleware
Base middleware with per-action authorization:
ModularService
Base service with caching and CRUD operations:
ModularObserver
Base observer for model lifecycle:
Register in a service provider:
JSON Response Format
Custom Stubs
You can customize the generated file templates:
Then edit files in stubs/modular/ directory.
Testing
Or run specific tests:
Contributing
Please see CONTRIBUTING for details.
Security
Please see SECURITY for our security policy.
License
The MIT License (MIT). Please see License File for more information.
Credits
All versions of modular-monolith-laravel with dependencies
illuminate/support Version ^9.0|^10.0|^11.0
illuminate/console Version ^9.0|^10.0|^11.0
illuminate/database Version ^9.0|^10.0|^11.0
illuminate/http Version ^9.0|^10.0|^11.0