Docker Compose + Documentation

RiasGFirst commented

2026-05-23 18:19:33 +00:00

Owner

Description : Conteneurisation complète de l'application et rédaction de la documentation technique pour faciliter l'onboarding et le déploiement.

Tâches

Créer un Dockerfile optimisé pour Node.js (multi-stage build si possible) dans le dossier backend/.
Mettre à jour le docker-compose.yml pour inclure le service api et le lier au service db.
Configurer les Networks Docker pour que l'API communique avec Postgres via le nom du service (ex: host: db au lieu de localhost).
Rédiger un README.md à la racine du projet.
Créer un dossier docs/ contenant la spécification des routes (format OpenAPI/Swagger ou Markdown simple).

Validations

Lancement unifié : La commande docker-compose up --build lance l'API et la BDD sans erreur.
Connectivité interne : Les logs de l'API confirment la connexion à la base de données à l'intérieur du réseau Docker.
Documentation d'installation : Le README.md contient une section "Installation" et "Usage" permettant de lancer le projet en moins de 3 commandes.
Catalogue d'API : Un fichier docs/endpoints.md liste toutes les routes (méthode, URL, paramètres, format de réponse) créées dans les issues #1, #2 et #3.
Nettoyage : Un fichier .dockerignore est présent pour éviter d'inclure les node_modules locaux dans l'image.

**Description** : Conteneurisation complète de l'application et rédaction de la documentation technique pour faciliter l'onboarding et le déploiement. ## Tâches * [ ] Créer un `Dockerfile` optimisé pour Node.js (multi-stage build si possible) dans le dossier `backend/`. * [ ] Mettre à jour le `docker-compose.yml` pour inclure le service `api` et le lier au service `db`. * [ ] Configurer les Networks Docker pour que l'API communique avec Postgres via le nom du service (ex: `host: db` au lieu de `localhost`). * [ ] Rédiger un `README.md` à la racine du projet. * [ ] Créer un dossier `docs/` contenant la spécification des routes (format OpenAPI/Swagger ou Markdown simple). ## Validations * [ ] Lancement unifié : La commande `docker-compose up --build` lance l'API et la BDD sans erreur. * [ ] Connectivité interne : Les logs de l'API confirment la connexion à la base de données à l'intérieur du réseau Docker. * [ ] Documentation d'installation : Le `README.md` contient une section "Installation" et "Usage" permettant de lancer le projet en moins de 3 commandes. * [ ] Catalogue d'API : Un fichier `docs/endpoints.md` liste toutes les routes (méthode, URL, paramètres, format de réponse) créées dans les issues #1, #2 et #3. * [ ] Nettoyage : Un fichier `.dockerignore` est présent pour éviter d'inclure les `node_modules` locaux dans l'image.

RiasGFirst added this to the Milestone 1 — Auth & Socle milestone

2026-05-23 18:19:33 +00:00

RiasGFirst added this to the RiasBudget project

2026-05-23 18:19:33 +00:00

RiasGFirst self-assigned this

2026-05-23 18:19:57 +00:00

RiasGFirst referenced this issue from a commit

2026-05-25 10:49:18 +00:00

feat: add Dockerfile, Dockerignore and documentation + README #4

RiasGFirst referenced this issue from a commit

2026-05-25 10:53:05 +00:00

docs: update CLAUDE.md #4