README.md

adresse.data.gouv.fr

Le site officiel de l'Adresse

Ce dépôt regroupe le code relatif à l'interface frontend du site adresse.data.gouv.fr.

Il utilise React, Next.js et MapLibre.

Développement

Pré-requis

• Node.js version 16 ou supérieure
• yarn (ou npm)

Installation des dépendances

yarn

Drapeaux disponible pour les langues régionales

$ yarn build-available-flags

Lancer en mode développement

yarn dev

Lancer en mode développement avec docker et docker-compose

docker-compose up --build -d

• --build permet de builder l'image qui est définie dans le Dockerfile.dev
• -d permet d'activer le 'detached mode' : execution des services en arrière-plan

Générer les assets pour la production

yarn build

Lancer en mode production

Les assets doivent être générés au préalable.

yarn start

Contrôler le style du code

Le style de code utilisé est xo.

yarn lint

Licence

Le code de ce logiciel est soumis à la licence MIT.