Developer Documentation
Architecture · Modules · APIs · Frontend · Security
Documentation in Progress
Full technical documentation is being written alongside the core.
In the meantime, refer to inline PHPDoc in
app/Core/
and the annotated source files in each module.
Core Subsystems
8 modules documentedArchitecture
MVC structure, namespace conventions, PSR-4 autoloading and the module/plugin system.
Modules
Create, register and activate business modules with routes, views and services.
Plugins
Cross-cutting plugins — middleware, consent management, SEO, payment gateways.
Routing
Registering routes, named parameters, middleware stacks and route groups.
Security
CSRF protection, rate limiting, CSP headers, encryption and session hardening.
Frontend
Tailwind v4 build pipeline, Alpine.js component registry and module CSS layers.
Database
Migrations, seeding, the Model base class, transactions and connection factory.
Internationalisation
i18n JSON files per module, LocaleManager, Translator and IntlFormatter.
Quick Reference
Key Directories
- app/Core/
- Framework kernel — HTTP, Auth, Hook, Navigation
- app/Setup/
- Installation tasks and ordered migrations
- modules/default/
- Default module — views, routes, services
- plugins/
- Cross-cutting plugin packages
- resources/scaffold/ui/CorePack/
- Shared UI templates and CorePack components
- public/Assets/css/
- Tailwind v4 input.css + compiled output.css
- public/Assets/js/
- Alpine.js app.js entry point
- storage/logs/
- Application log files (writable)
- storage/cache/
- Compiled view cache and data cache
- .env
- Environment configuration (never commit to VCS)
CLI Commands
php bsbv …- php bsbv key:generate
- Generate a new APP_KEY encryption key
- php bsbv module:create {name}
- Scaffold a new module skeleton
- php bsbv plugin:create {name}
- Scaffold a new plugin skeleton
- php bsbv migrate:run
- Run all pending database migrations
- php bsbv migrate:rollback
- Roll back the last migration batch
- php bsbv cache:clear
- Flush compiled view and data caches
- npx @tailwindcss/cli --watch
- Build Tailwind CSS in watch mode