System Reference ​
Modularous (Modularous) is a Laravel package that provides a modular admin panel powered by Vue.js, Vuetify, and Inertia. It uses the Repository pattern for data access, config-driven forms and tables, and a Hydrate system to transform module config into frontend schema.
Documentation Index ​
| Page | Description |
|---|---|
| Architecture | System overview, request flow, schema flow, core classes |
| Hydrates | Backend → frontend schema transformation (input types) |
| Repositories | Data access layer, lifecycle, Logic traits |
| Backend | Controllers, Console commands, Entities, Services |
| Frontend | Vue structure, form/table flow, hooks, store |
| Config | Configuration layers (merges, defers, publishes) |
| Modules | Module vs route activation, structure |
| API | Common patterns and use cases |
| Pinia Migration | Vuex → Pinia migration path |
| Console Conventions | Command naming and signature rules |
| Entities | Models, entity traits, enums |
| Features Pattern | Entity + Repository + Hydrate triple pattern |
Guides
| Page | Description |
|---|---|
| Remote API | Sync entities from external JSON APIs (connector, cache, admin UI) |
Quick Reference ​
Key config keys
modularous.services.*— services (currency_exchange, etc.)modularous.roles— role definitionsmodularous.traits— entity traitsmodularous.paths— base pathsmodularous.currency_provider— currency provider FQCN
Key commands
modularous:build— rebuild Vue assetsmodularous:route:enable/modularous:route:disable— toggle routesmodularous:route:status— list route status per module
Paths
- Package source:
packages/modularous/src/ - Vue source:
packages/modularous/vue/src/js/ - Modules:
config('modules.paths.modules')(default:modules/)
For Contributors ​
See AGENTS.md for package development rules, patterns, and conventions.