France Chaleur Urbaine

Le site officiel de france-chaleur-urbaine.beta.gouv.fr

Ce dépôt regroupe le code relatif au site france-chaleur-urbaine.beta.gouv.fr.

Il utilise, entre autre, Docker, React, Next.js, PostgreSQL et MapLibre.

Installation de l'environnement de développement

Pré-requis :

• Node.js version 20

• Yarn

• Docker

• Récupérer le dump des tables de référence auprès d'un membre de l'équipe

• Récupérer le fichier .env.local auprès d'un membre de l'équipe

• Installer les dépendances

yarn

• Déposer le fichier .env.local à la racine du projet.

• Lancer les conteneurs Docker (services annexes + app next).

docker compose up -d

• Appliquer les migrations de la BDD.

DATABASE_URL="postgres://postgres:postgres_fcu@localhost:5432/postgres" yarn db:migrate

• Importer le fichier dump.sql dans la BDD (~ 20-30 minutes)

pg_restore --clean --if-exists --no-owner --no-privileges --no-comments --dbname postgres://postgres:postgres_fcu@localhost:5432/postgres dump.sql

• Désormais, sont accessibles :
  • Le site internet : http://localhost:3000/
  • L'interface maildev pour les emails : http://localhost:1080/
  • La base de données PostgreSQL : localhost:5432

Lint

• Prettier est utilisé comme formatteur de code.
• ESLint est utilisé pour détecter les erreurs de programmation.

yarn lint

Tests

Vitest est le framework utilisé pour les tests unitaires.

yarn test

Build

yarn build

Note : Il se peut qu'un problème de permissions survienne sur le dossier .next qui est monté dans le conteneur Docker. Dans ce cas, la commande sudo chown -R $USER: .next corrige le problème.

Licence

Le code de ce logiciel est soumis à la licence Etalab 2.0.