Classeo/README.md

Classeo

Application de gestion scolaire moderne - Backend Symfony 8 + Frontend SvelteKit 2.

Quick Start

Prérequis

• Docker Desktop 24+ avec Docker Compose 2.20+
• Git

Installation

# 1. Cloner le repo
git clone https://github.com/ClasseoEdu/classeo.git
cd classeo

# 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'

# 3. Installation complète (démarre les services, génère les clés JWT, warmup cache)
make install

# 4. Vérifier que tout fonctionne
make ps
make check-tenants

C'est tout ! L'application est prête.

Commandes utiles

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

# 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

Service	URL	Description
Frontend Alpha	http://ecole-alpha.classeo.local:5174	Tenant ecole-alpha
Frontend Beta	http://ecole-beta.classeo.local:5174	Tenant ecole-beta
API Alpha	http://ecole-alpha.classeo.local:18000/api	API tenant ecole-alpha
API Beta	http://ecole-beta.classeo.local:18000/api	API tenant ecole-beta
API Docs	http://ecole-alpha.classeo.local:18000/api/docs	Documentation OpenAPI

Services partagés

Service	URL	Description
RabbitMQ	http://localhost:15672	Admin (guest/guest)
Meilisearch	http://localhost:7700	Dashboard recherche
Mailpit	http://localhost:8025	Emails de test
Mercure	http://localhost:3000/.well-known/mercure	SSE Hub

Stack Technique

Backend

• PHP 8.5 avec property hooks et asymmetric visibility
• Symfony 8.0 - Framework DDD-friendly
• 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

• SvelteKit 2.x - SSR, routing, PWA
• Svelte 5 - Runes ($state, $derived, $effect)
• TypeScript strict - Typage fort
• TanStack Query 5 - Server state management
• Tailwind CSS 3 - Utility-first CSS

Infrastructure

• PostgreSQL 18.1 - Base de données
• Redis 7.4 - Cache + Sessions
• RabbitMQ 4.2 - Message queue
• Mercure - Real-time SSE
• Meilisearch 1.12 - Full-text search
• Mailpit - Email testing

Architecture

Bounded Contexts

backend/src/
├── Administration/  # Gestion établissement, utilisateurs
├── Scolarite/       # Notes, classes, emploi du temps
├── VieScolaire/     # Absences, retards, sanctions
├── Communication/   # Messages, notifications
└── Shared/          # Kernel partagé (EntityId, DomainEvent, etc.)

Structure DDD

Chaque Bounded Context suit la même structure :

{BC}/
├── Domain/           # Pure PHP - ZERO dépendance framework
│   ├── Model/        # Aggregates, Entities, Value Objects
│   ├── Event/        # Domain Events
│   ├── Repository/   # Interfaces repository
│   └── Service/      # Domain Services
├── Application/      # Use cases
│   ├── Command/      # Write operations
│   ├── Query/        # Read operations
│   └── EventHandler/ # Domain event handlers
└── Infrastructure/   # Implémentations framework
    ├── Persistence/  # Doctrine repositories
    ├── Api/          # API Platform resources
    └── Messaging/    # RabbitMQ handlers

Développement

Workflow quotidien

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

Backend

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

make lint            # ESLint
make check-types     # TypeScript check
make test-js         # Tests Vitest
make e2e             # Tests Playwright

Shell

make shell           # Shell dans le container PHP
make shell-frontend  # Shell dans le container frontend

Tests

Tests unitaires et intégration (dans Docker)

make test          # Tous les tests (PHPUnit + Vitest)
make test-php      # PHPUnit uniquement
make test-js       # Vitest uniquement
make ci            # Tous les checks + tests

Tests E2E Playwright (depuis l'hôte)

Les tests E2E nécessitent Node.js sur l'hôte (pas dans Docker) :

# 1. Installer pnpm si pas déjà fait
npm install -g pnpm

# 2. Installer les dépendances frontend
cd frontend && pnpm install

# 3. Installer les navigateurs Playwright
pnpm exec playwright install
# ou avec npx : npx playwright install

# 4. S'assurer que l'app tourne
make up

# 5. Lancer les tests E2E
make e2e

# Ou en mode UI pour debug
cd frontend && pnpm exec playwright test --ui

Pourquoi depuis l'hôte ? Les tests E2E utilisent docker compose exec pour créer des utilisateurs de test, ce qui nécessite l'accès au CLI Docker.

Problèmes de permissions ? Si vous avez des erreurs EACCES, corrigez les permissions :

docker run --rm -v $(pwd)/frontend:/app alpine chown -R $(id -u):$(id -g) /app/.svelte-kit /app/node_modules /app/test-results

Documentation

• Architecture Decision Records
• Contributing Guide
• API Documentation

Licence

Proprietary - ClasseoEdu