|
| 1 | +# Installation Backend + PostgreSQL |
| 2 | + |
| 3 | +## 🎯 Objectif |
| 4 | + |
| 5 | +Démarrer un environnement de développement avec PostgreSQL en Docker et le backend DomiFa. |
| 6 | + |
| 7 | +## 🐳 Modes de développement |
| 8 | + |
| 9 | +### Mode hybride (recommandé) |
| 10 | + |
| 11 | +PostgreSQL en Docker + Backend en local avec yarn workspaces - permet un meilleur contrôle du développement. |
| 12 | + |
| 13 | +### Mode Docker complet |
| 14 | + |
| 15 | +Tous les services dans Docker - utile pour la reproductibilité mais moins flexible pour le développement. |
| 16 | + |
| 17 | +## ⚙️ Configuration des variables d'environnement |
| 18 | + |
| 19 | +### Fichiers requis (obligatoires) |
| 20 | + |
| 21 | +```bash |
| 22 | +# 1. Configuration racine |
| 23 | +cp .env.dev.example.env .env |
| 24 | + |
| 25 | +# 2. Configuration backend |
| 26 | +cp packages/backend/.env.backend.dev.example.env packages/backend/.env |
| 27 | + |
| 28 | +# 3. Configuration tests (optionnel) |
| 29 | +cp packages/backend/.env.backend.test.local.example.env packages/backend/.env.backend.test.local.env |
| 30 | +``` |
| 31 | + |
| 32 | +### Configuration de la connexion PostgreSQL |
| 33 | + |
| 34 | +**Mode Docker complet** (Backend aussi en Docker) : |
| 35 | + |
| 36 | +```env |
| 37 | +# Dans packages/backend/.env |
| 38 | +POSTGRES_HOST=postgres |
| 39 | +# OU utiliser le preset |
| 40 | +DOMIFA_ENV_PRESET=local-dev-docker.preset.env |
| 41 | +``` |
| 42 | + |
| 43 | +**Mode hybride** (Backend en local, PostgreSQL en Docker) : |
| 44 | + |
| 45 | +```env |
| 46 | +# Dans packages/backend/.env |
| 47 | +POSTGRES_HOST=localhost |
| 48 | +# OU utiliser le preset |
| 49 | +DOMIFA_ENV_PRESET=local-dev.preset.env |
| 50 | +``` |
| 51 | + |
| 52 | +## 🐳 Lancement de l'environnement Docker |
| 53 | + |
| 54 | +### Démarrage des services |
| 55 | + |
| 56 | +```bash |
| 57 | +# PostgreSQL uniquement (recommandé avec yarn workspaces) |
| 58 | +./docker-compose.local.run.sh |
| 59 | + |
| 60 | +# PostgreSQL + Backend en Docker (mode conteneurisé) |
| 61 | +./docker-compose.local.run.sh --with-dev-containers |
| 62 | +``` |
| 63 | + |
| 64 | +### Gestion des containers |
| 65 | + |
| 66 | +```bash |
| 67 | +# Arrêter les services |
| 68 | +./docker-compose.local.run.sh --stop |
| 69 | + |
| 70 | +# Supprimer les containers |
| 71 | +./docker-compose.local.run.sh --stop --remove |
| 72 | + |
| 73 | +# Reset complet (⚠️ SUPPRIME TOUTES LES DONNÉES DOMIFA) |
| 74 | +./docker-compose.local.run.sh --stop --remove --drop-domifa-volumes |
| 75 | +``` |
| 76 | + |
| 77 | +## 🗄️ Base de données PostgreSQL |
| 78 | + |
| 79 | +### Initialisation automatique |
| 80 | + |
| 81 | +Les bases de données sont créées automatiquement au premier démarrage avec des données de test. |
| 82 | + |
| 83 | +> 📖 Voir [./20.databases-dumps.md](./20.databases-dumps.md) pour plus de détails |
| 84 | +
|
| 85 | +### Vérification |
| 86 | + |
| 87 | +```bash |
| 88 | +# Vérifier que PostgreSQL fonctionne |
| 89 | +docker ps | grep postgres |
| 90 | +docker logs domifa-postgres |
| 91 | +``` |
| 92 | + |
| 93 | +## 🚀 Démarrage du Backend |
| 94 | + |
| 95 | +### Mode hybride avec yarn workspaces (recommandé) |
| 96 | + |
| 97 | +```bash |
| 98 | +# À la racine du projet - démarre le backend via workspace |
| 99 | +yarn workspace @domifa/backend start:dev |
| 100 | + |
| 101 | +# OU directement dans le dossier backend |
| 102 | +cd packages/backend |
| 103 | +yarn start:dev |
| 104 | +``` |
| 105 | + |
| 106 | +### Mode Docker complet |
| 107 | + |
| 108 | +```bash |
| 109 | +# Entrer dans le container backend |
| 110 | +docker exec -it domifa-backend bash |
| 111 | + |
| 112 | +# Dans le container |
| 113 | +yarn start:dev |
| 114 | +``` |
| 115 | + |
| 116 | +## 🔧 Commandes utiles |
| 117 | + |
| 118 | +```bash |
| 119 | +# Voir les logs PostgreSQL |
| 120 | +docker logs domifa-postgres -f |
| 121 | + |
| 122 | +# Voir les logs Backend (si en Docker) |
| 123 | +docker logs domifa-backend -f |
| 124 | + |
| 125 | +# Reset uniquement la base de données |
| 126 | +docker volume rm domifa_postgres_data |
| 127 | + |
| 128 | +# Migrations manuelles |
| 129 | +yarn workspace @domifa/backend db:dev:migrate-up |
| 130 | +yarn workspace @domifa/backend db:dev:create -- NomDeLaMigration |
| 131 | +``` |
| 132 | + |
| 133 | +## 🚨 Dépannage |
| 134 | + |
| 135 | +### PostgreSQL ne démarre pas |
| 136 | + |
| 137 | +```bash |
| 138 | +# Vérifier les logs |
| 139 | +docker logs domifa-postgres |
| 140 | + |
| 141 | +# Vérifier l'espace disque |
| 142 | +df -h |
| 143 | + |
| 144 | +# Nettoyer les volumes orphelins |
| 145 | +docker volume prune |
| 146 | +``` |
| 147 | + |
| 148 | +### Backend ne se connecte pas à PostgreSQL |
| 149 | + |
| 150 | +```bash |
| 151 | +# Vérifier la configuration |
| 152 | +cat packages/backend/.env | grep POSTGRES |
| 153 | + |
| 154 | +# Vérifier que PostgreSQL accepte les connexions |
| 155 | +telnet localhost 5432 |
| 156 | +``` |
| 157 | + |
| 158 | +### Port 3000 déjà utilisé |
| 159 | + |
| 160 | +```bash |
| 161 | +# Identifier le processus |
| 162 | +lsof -i :3000 |
| 163 | +kill -9 <PID> |
| 164 | +``` |
| 165 | + |
| 166 | +### Modules manquants |
| 167 | + |
| 168 | +```bash |
| 169 | +# Réinstaller les dépendances backend |
| 170 | +cd packages/backend |
| 171 | +yarn install |
| 172 | +``` |
| 173 | + |
| 174 | +## 🎯 Résultat attendu |
| 175 | + |
| 176 | +À la fin de cette installation, vous devez avoir : |
| 177 | + |
| 178 | +- ✅ PostgreSQL accessible sur `localhost:5432` |
| 179 | +- ✅ Backend API accessible sur `http://localhost:3000` |
0 commit comments