Aller au contenu principal

Installation

Prérequis

  • Node.js 20+
  • Docker (pour la Base de données et Redis)

Développement Local

1. Démarrer l'Infrastructure

Nous fournissons un docker-compose.yml qui démarre tout l'écosystème :

  • MySQL 8 (DB Principale)
  • Redis (Cache & PubSub)
  • RTSPtoWeb (Proxy de streaming)
  • MediaMTX (Serveur RTSP pour tester avec des faux flux)
  • Prometheus & Grafana (Monitoring)
cd Control-Hub-Back
docker-compose up -d --build

2. Configurer l'Environnement

Copiez .env.example -> .env.

Variables Clés :

  • APP_KEY : Secret générique de 32 char.
  • DB_MAIN_* : Identifiants DB (défaut : root / root dans docker-compose).
  • REDIS_* : Connexion Redis (défaut : localhost / 6379).
  • RTSP_TO_WEB_URL : URL du service Go (ex: http://localhost:8083).
  • TWILIO_* : (Optionnel) Pour les alertes SMS.
  • VAPID_* : (Optionnel) Pour les notifications Push Web/Mobile.

3. Exécuter les Migrations & Seed

Initialiser le schéma de DB :

# Si lancé localement via Node
node ace migration:run
node ace db:seed

# Si lancé dans Docker
docker exec -it adonis-dev node ace migration:run
docker exec -it adonis-dev node ace db:seed

4. Scripts Disponibles

CommandeDescription
npm run devDémarrer serveur dev avec HMR.
npm run docsGénérer TypeDoc (référence API). OpenAPI/Swagger est exposé à l'exécution par l'API.
npm run typecheckValider TypeScript sans compiler.
npm run formatCorriger formatage Prettier.