Files
benevoles/README.md
T
AdamThomasandClaude Sonnet 5 b894b1d270 Makefile : make demo et make blank en une commande
- make demo  : db + backend + frontend + jeu de démonstration
- make blank : idem mais édition vierge + 1er compte coordination (params
  surchargeables : EMAIL, PASSWORD, NAME, START, END)
Chaque cible applique les migrations, prépare les données et bascule le
frontend sur l'API réelle (VITE_* dans .env). `make down` / `make logs`.

app/bootstrap.py : commande sous-jacente de `make blank`.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017uUsRg7XzopkCPWimwg9ZM
2026-09-10 21:14:00 +02:00

52 lines
1.8 KiB
Markdown

# Gestion des bénévoles
Application web de gestion des bénévoles pour un festival associatif.
Backend FastAPI + PostgreSQL, frontend React (à venir), déploiement Docker
Compose auto-hébergé.
Voir [`CLAUDE.md`](./CLAUDE.md) pour le vocabulaire du domaine, l'arborescence
et les conventions.
## Démarrage rapide
```bash
make demo # base + backend + frontend, jeu de démonstration chargé
make blank # idem, mais édition vierge + 1er compte coordination
```
- Frontend : http://localhost:5173
- API : http://localhost:8000 · Docs : http://localhost:8000/docs
- `make down` arrête tout · `make logs` suit les logs du backend
Chaque commande construit les images, applique les migrations, prépare les
données, bascule le frontend sur l'API réelle (`.env`) et affiche les
identifiants de connexion.
**`make blank`** accepte des paramètres :
```bash
make blank EMAIL=moi@festival.fr PASSWORD=mon-mot-de-passe-solide \
NAME="Festival 2026" START=2026-07-01 END=2026-07-04
```
Le jeu de démo : 120 bénévoles fictifs, 15 postes, 4 jours. L'édition vierge :
une édition + un compte coordination (mot de passe) + 3 créneaux types.
## Tests
```bash
docker compose run --rm backend uv run pytest
```
La base de test (`benevoles_test`) est créée automatiquement au premier
démarrage du conteneur PostgreSQL.
## Structure
| Dossier | Rôle |
|--------------|-------------------------------------------------|
| `backend/` | API FastAPI, modèle SQLModel, migrations Alembic |
| `frontend/` | Interface React + Vite + TS + Tailwind (service `frontend`) |
| `deploy/` | Configuration de déploiement production |
| `.github/` | Chaîne CI/CD (build → GHCR → SSH sur le VPS) |