README.md

geo.data.gouv.fr

Trouvez facilement les données géographiques dont vous avez besoin

Présentation

Interface du site geo.data.gouv.fr basée sur les API de la plateforme Inspire et développée par la mission Etalab.

Ce projet front est basé sur Next.js, il utilise React.

Contribuer au code

Prérequis

• Node.js >= 8
• yarn (mais ça fonctionne aussi avec npm)

Installation des dépendances

yarn

Développement

Afin de configurer le projet correctement, il est conseillé de créer un fichier .env avec les variables d’environnement nécessaires à l’application.

.env permet de persister les variables d’environnement de développement dans un fichier plutôt que de les définir dans le shell, mais les deux fonctionnent. Cela fonctionne avec dotenv et next-runtime-dotenv.

Un fichier d’example existe : .env.example. Pour obtenir une configuration de base :

cp .env.sample .env

Enfin, lancer le serveur de développement avec :

yarn dev

Tests

yarn test

Génération des bundles de production

yarn build

Lancer le serveur en mode production

Il utilisera les bundles générés par yarn build.

yarn start

Génération de Changelog

La génération de changelog pour chaque tag sur GitHub se fait à l’aide de lerna-changelog.

GITHUB_AUTH=… yarn lerna-changelog

Pour générer le changelog que pour le dernier tag, utiliser l’option --tag-from avec comme argument le précédent tag.

Par exemple:

GITHUB_AUTH=… yarn lerna-changelog --tag-from v2.2.1

Le jeton d’authentification GitHub passé à l’aide de la variable d’environnement GITHUB_AUTH doit avoir le scope public_repo.

La génération du changelog et la création de releases GitHub sont automatisées par CircleCI à chaque publication de tag.

Docker

Une image est disponible sur le hub docker :

$ docker pull geodatagouv/geo.data.gouv.fr:latest

Mainteneurs principaux

Jérôme Desboeufs, Théophile Merlière et Bertrand Marron

Ce projet est largement ouvert aux contributions.

License

MIT

Divers

    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝