docs: Makefile autodocumenté et README simplifié
L'installation du projet nécessitait plusieurs commandes manuelles et le Makefile listait les commandes dans un bloc help statique, difficile à maintenir et susceptible de devenir obsolète. Le Makefile utilise maintenant le pattern "## description" qui génère automatiquement l'aide à partir des commentaires inline. Le README est simplifié avec un `make install` unique qui orchestre tout le setup.
This commit is contained in:
117
README.md
117
README.md
@@ -4,39 +4,56 @@ Application de gestion scolaire moderne - Backend Symfony 8 + Frontend SvelteKit
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Prerequis
|
||||
### Prérequis
|
||||
|
||||
- Docker Desktop 24+ avec Docker Compose 2.20+
|
||||
- Git
|
||||
|
||||
### Configuration /etc/hosts (multi-tenant)
|
||||
|
||||
Classeo utilise une architecture multi-tenant basée sur les sous-domaines. Ajoutez cette ligne à `/etc/hosts` :
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
sudo sh -c 'echo "127.0.0.1 classeo.local ecole-alpha.classeo.local ecole-beta.classeo.local" >> /etc/hosts'
|
||||
```
|
||||
|
||||
### Lancement
|
||||
|
||||
```bash
|
||||
# Cloner le repo
|
||||
# 1. Cloner le repo
|
||||
git clone https://github.com/ClasseoEdu/classeo.git
|
||||
cd classeo
|
||||
|
||||
# Lancer tous les services
|
||||
docker compose up -d
|
||||
# 2. Configurer /etc/hosts pour le multi-tenant
|
||||
sudo sh -c 'echo "127.0.0.1 classeo.local ecole-alpha.classeo.local ecole-beta.classeo.local" >> /etc/hosts'
|
||||
|
||||
# Verifier le statut
|
||||
docker compose ps
|
||||
# 3. Installation complète (démarre les services, génère les clés JWT, warmup cache)
|
||||
make install
|
||||
|
||||
# Verifier que les tenants répondent
|
||||
# 4. Vérifier que tout fonctionne
|
||||
make ps
|
||||
make check-tenants
|
||||
```
|
||||
|
||||
C'est tout ! L'application est prête.
|
||||
|
||||
### Commandes utiles
|
||||
|
||||
```bash
|
||||
make help # Afficher toutes les commandes disponibles
|
||||
make logs # Voir les logs des services
|
||||
make test # Lancer tous les tests
|
||||
make check # Lancer tous les linters
|
||||
```
|
||||
|
||||
### Créer un utilisateur de test
|
||||
|
||||
```bash
|
||||
# Mode interactif
|
||||
make token
|
||||
|
||||
# Créer rapidement un parent sur ecole-alpha
|
||||
make token-alpha
|
||||
|
||||
# Créer un prof sur ecole-beta
|
||||
make token-beta role=ROLE_PROF email=prof@test.com
|
||||
```
|
||||
|
||||
### URLs
|
||||
|
||||
#### Multi-tenant (recommandé)
|
||||
#### Multi-tenant
|
||||
|
||||
| Service | URL | Description |
|
||||
|---------|-----|-------------|
|
||||
@@ -61,8 +78,8 @@ make check-tenants
|
||||
|
||||
- **PHP 8.5** avec property hooks et asymmetric visibility
|
||||
- **Symfony 8.0** - Framework DDD-friendly
|
||||
- **API Platform 4.x** - API REST auto-generee
|
||||
- **Doctrine ORM 3.x** - Persistence avec mappings separes
|
||||
- **API Platform 4.x** - API REST auto-générée
|
||||
- **Doctrine ORM 3.x** - Persistence avec mappings séparés
|
||||
- **PHPStan level 9** - Analyse statique stricte
|
||||
|
||||
### Frontend
|
||||
@@ -75,7 +92,7 @@ make check-tenants
|
||||
|
||||
### Infrastructure
|
||||
|
||||
- **PostgreSQL 18.1** - Base de donnees
|
||||
- **PostgreSQL 18.1** - Base de données
|
||||
- **Redis 7.4** - Cache + Sessions
|
||||
- **RabbitMQ 4.2** - Message queue
|
||||
- **Mercure** - Real-time SSE
|
||||
@@ -88,20 +105,20 @@ make check-tenants
|
||||
|
||||
```
|
||||
backend/src/
|
||||
├── Administration/ # Gestion etablissement, utilisateurs
|
||||
├── Administration/ # Gestion établissement, utilisateurs
|
||||
├── Scolarite/ # Notes, classes, emploi du temps
|
||||
├── VieScolaire/ # Absences, retards, sanctions
|
||||
├── Communication/ # Messages, notifications
|
||||
└── Shared/ # Kernel partage (EntityId, DomainEvent, etc.)
|
||||
└── Shared/ # Kernel partagé (EntityId, DomainEvent, etc.)
|
||||
```
|
||||
|
||||
### Structure DDD
|
||||
|
||||
Chaque Bounded Context suit la meme structure :
|
||||
Chaque Bounded Context suit la même structure :
|
||||
|
||||
```
|
||||
{BC}/
|
||||
├── Domain/ # Pure PHP - ZERO dependance framework
|
||||
├── Domain/ # Pure PHP - ZERO dépendance framework
|
||||
│ ├── Model/ # Aggregates, Entities, Value Objects
|
||||
│ ├── Event/ # Domain Events
|
||||
│ ├── Repository/ # Interfaces repository
|
||||
@@ -110,42 +127,52 @@ Chaque Bounded Context suit la meme structure :
|
||||
│ ├── Command/ # Write operations
|
||||
│ ├── Query/ # Read operations
|
||||
│ └── EventHandler/ # Domain event handlers
|
||||
└── Infrastructure/ # Implementations framework
|
||||
└── Infrastructure/ # Implémentations framework
|
||||
├── Persistence/ # Doctrine repositories
|
||||
├── Api/ # API Platform resources
|
||||
└── Messaging/ # RabbitMQ handlers
|
||||
```
|
||||
|
||||
## Developpement
|
||||
## Développement
|
||||
|
||||
### Commandes utiles
|
||||
### Workflow quotidien
|
||||
|
||||
```bash
|
||||
# Backend
|
||||
docker compose exec php composer phpstan # Analyse statique
|
||||
docker compose exec php composer test # Tests PHPUnit
|
||||
docker compose exec php composer cs-fix # Correction code style
|
||||
|
||||
# Frontend
|
||||
docker compose exec frontend pnpm run lint # ESLint
|
||||
docker compose exec frontend pnpm run check # TypeScript check
|
||||
docker compose exec frontend pnpm run test # Vitest
|
||||
docker compose exec frontend pnpm run test:e2e # Playwright
|
||||
make up # Démarrer les services
|
||||
make logs # Suivre les logs
|
||||
make test # Lancer les tests avant commit
|
||||
make check # Vérifier la qualité du code
|
||||
```
|
||||
|
||||
### Makefile (raccourcis)
|
||||
### Backend
|
||||
|
||||
```bash
|
||||
make up # docker compose up -d
|
||||
make down # docker compose down
|
||||
make logs # docker compose logs -f
|
||||
make test # Run all tests
|
||||
make lint # Run all linters
|
||||
make phpstan # Analyse statique
|
||||
make test-php # Tests PHPUnit
|
||||
make cs-fix # Corriger le code style
|
||||
make arch # Tests d'architecture
|
||||
make console c='...' # Commande Symfony
|
||||
```
|
||||
|
||||
### Frontend
|
||||
|
||||
```bash
|
||||
make lint # ESLint
|
||||
make check-types # TypeScript check
|
||||
make test-js # Tests Vitest
|
||||
make e2e # Tests Playwright
|
||||
```
|
||||
|
||||
### Shell
|
||||
|
||||
```bash
|
||||
make shell # Shell dans le container PHP
|
||||
make shell-frontend # Shell dans le container frontend
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
- **PHPUnit** - Tests unitaires et integration backend
|
||||
- **PHPUnit** - Tests unitaires et intégration backend
|
||||
- **Vitest** - Tests unitaires frontend
|
||||
- **Playwright** - Tests E2E
|
||||
|
||||
@@ -153,7 +180,7 @@ make lint # Run all linters
|
||||
|
||||
- [Architecture Decision Records](./docs/adr/)
|
||||
- [Contributing Guide](./CONTRIBUTING.md)
|
||||
- [API Documentation](http://localhost:8000/api/docs)
|
||||
- [API Documentation](http://ecole-alpha.classeo.local:18000/api/docs)
|
||||
|
||||
## Licence
|
||||
|
||||
|
||||
Reference in New Issue
Block a user