57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
|
# 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](./project-overview.md) — Purpose, features, domain model, tech stack summary
|
||
|
|
- [Architecture](./architecture.md) — Architecture pattern, data models, routes, auth, frontend design, CI/CD
|
||
|
|
- [Source Tree Analysis](./source-tree-analysis.md) — Annotated directory tree, critical folders
|
||
|
|
- [Development Guide](./development-guide.md) — Setup, commands, testing, code quality, patterns
|
||
|
|
- [API Contracts](./api-contracts.md) _(To be generated)_
|
||
|
|
- [Data Models](./data-models.md) _(To be generated)_
|
||
|
|
- [Component Inventory](./component-inventory.md) _(To be generated)_
|
||
|
|
|
||
|
|
## Existing Documentation
|
||
|
|
|
||
|
|
- [AGENTS.md](../AGENTS.md) — Laravel Boost AI guidelines, coding conventions, testing rules
|
||
|
|
- [.github/workflows/lint.yml](../.github/workflows/lint.yml) — GitHub Actions linting pipeline
|
||
|
|
- [.github/workflows/tests.yml](../.github/workflows/tests.yml) — GitHub Actions test pipeline
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
1. Clone the repository
|
||
|
|
2. Run `composer install && npm install`
|
||
|
|
3. Copy `.env.example` to `.env` and generate key: `php artisan key:generate`
|
||
|
|
4. Start Docker: `vendor/bin/sail up -d`
|
||
|
|
5. Run migrations: `vendor/bin/sail artisan migrate`
|
||
|
|
6. Start dev servers: `vendor/bin/sail composer run dev`
|
||
|
|
7. 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 |
|