Saad Ibn-Ezzoubayr
35545c2a8f
Initial commit of the L'Ami Fiduciaire SaaS platform built on Laravel 12, Vue 3, Inertia.js 2, and Tailwind CSS 4. Story 0.1 (rename folders to declarations in database) is implemented and code-reviewed: migration, rollback, and 6 Pest tests all passing. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2.4 KiB
2.4 KiB
L'Ami Fiduciaire — Project Documentation Index
Generated: 2026-03-08 | Scan Level: Quick | Workflow: initial_scan
Project Overview
- Type: Monolith (full-stack web application)
- Primary Language: PHP 8.4 (backend) + TypeScript (frontend)
- Architecture: Server-Driven SPA (Laravel 12 + Inertia.js v2 + Vue 3)
- Database: MySQL 8.4
- Domain: Fiduciary/accounting firm client & document management
Quick Reference
- Backend: Laravel 12, Fortify (auth), Eloquent ORM, Spatie packages
- Frontend: Vue 3 + TypeScript, Tailwind CSS 4, shadcn-vue, Vite 7
- Entry Points:
artisan(CLI),resources/js/app.ts(frontend),resources/js/ssr.ts(SSR) - Architecture Pattern: Inertia.js server-driven SPA (no REST API layer)
- Dev Command:
vendor/bin/sail composer run dev
Generated Documentation
- Project Overview — Purpose, features, domain model, tech stack summary
- Architecture — Architecture pattern, data models, routes, auth, frontend design, CI/CD
- Source Tree Analysis — Annotated directory tree, critical folders
- Development Guide — Setup, commands, testing, code quality, patterns
- API Contracts (To be generated)
- Data Models (To be generated)
- Component Inventory (To be generated)
Existing Documentation
- AGENTS.md — Laravel Boost AI guidelines, coding conventions, testing rules
- .github/workflows/lint.yml — GitHub Actions linting pipeline
- .github/workflows/tests.yml — GitHub Actions test pipeline
Getting Started
- Clone the repository
- Run
composer install && npm install - Copy
.env.exampleto.envand generate key:php artisan key:generate - Start Docker:
vendor/bin/sail up -d - Run migrations:
vendor/bin/sail artisan migrate - Start dev servers:
vendor/bin/sail composer run dev - Access the app at
http://localhost
Key Entities
| Entity | Description |
|---|---|
| Workspace | Multi-tenant workspace for a firm |
| User | Firm employee with workspace role |
| Client | Business client of the firm |
| Folder | Document dossier for a client |
| FolderInvitation | Token-based external access link |
| Message | In-folder communication |