How mwaseem91/roles-and-permissions-inertia works
Project type and purpose
• This is a full‑stack web application built on Laravel (PHP) with an Inertia.js front‑end (Vue).
• Purpose: provide an admin panel for managing users, roles, permissions and modules.
Top‑level architectural components
a. Client (Browser)
• Vue.js single‑page app powered by Inertia
• Components & Pages under resources/js
b. Web Server & PHP Application
• public/index.php → bootstrap/app.php → HTTP Kernel
• Middleware (HandleInertiaRequests, auth checks)
• Controllers (app/Http/Controllers/Admin, UserController, RoleController, etc.)
• Requests & Validation (app/Http/Requests/*Request.php)
• Models & Business Logic (app/Models/User.php, Module.php + Spatie Permissions)
c. Data Storage & Services
• MySQL (or configured SQL database) via Eloquent ORM
• Caching & Queue drivers (Redis, database—config/cache.php, config/queue.php)
• Mail (SMTP or service—config/mail.php)
• File storage (local or S3—config/filesystems.php)
d. Asset Pipeline
• Vite (vite.config.js) or Laravel Mix (package.json) compiles CSS/JS → public/global & mix manifests
Relationships & Data Flows
• Browser → HTTP(S) Request → Web Server (Nginx/Apache) → Laravel (public/index.php)
• Kernel applies Middleware → Routes (routes/web.php, routes/auth.php)
• Controller handles request, uses Request objects for validation
• Controller calls Eloquent Models & Spatie-permission services → Database
• Controller returns Inertia::render() → JSON payload + Vue component
• Browser receives JSON + component props, re‑renders SPA
• Background tasks (emails, jobs) pushed to Queue → Queue Worker → services (mail, cache)
• Caching layer for repeated queries; logs written to storage/logs
Architectural patterns & design principles
• MVC (Models, Controllers, Views) extended via Inertia as View layer
• “Single‑Page Application” pattern without a separate API server
• Role‑Based Access Control (RBAC) via Spatie Permissions
• Separation of concerns:
• Validation in FormRequest classes
• Database seeds & migrations for repeatable schema/data
• Asset compilation separated by Vite/Mix
Essential elements
• Frontend: Browser + Inertia/Vue components
• Backend: Laravel Kernel → Middleware → Controllers → Models
• Data stores: MySQL, Redis (cache/queue), Storage
• Services: Mail, (optionally) S3 or FTP
• Build tools: Vite or Laravel Mix; Node/NPM