An open API service indexing awesome lists of open source software.

https://github.com/baseadressenationale/adresse.data.gouv.fr

Le site officiel de l'Adresse
https://github.com/baseadressenationale/adresse.data.gouv.fr

adresse dataset open-data

Last synced: 2 months ago
JSON representation

Le site officiel de l'Adresse

Awesome Lists containing this project

README

          

# adresse.data.gouv.fr

_[Le site officiel de l'Adresse en France](https://adresse.data.gouv.fr/)_

Ce dépôt contient le code logiciel FrontEnd du site [adresse.data.gouv.fr](https://adresse.data.gouv.fr/), développé sur le framework [Next.js](https://nextjs.org).

## Pré-requis

Ce site nécéssite l'instalation préalable des outils suivants :

* Node.JS version 20 ou supérieure
* NPM version 10 ou supérieure

## Développement

### Installation des dépendances

```bash
npm install
```

### Demarrer en le serveur de développement

```bash
npm run dev
```

### Demarrer le serveur de développement avec le proxy
Ajouter le fichier index.js dans un dossier proxy à la racine des différents projets avec le contenu suivant :

```bash
const { setGlobalDispatcher, fetch, EnvHttpProxyAgent } = require('undici')
const envHttpProxyAgent = new EnvHttpProxyAgent()
setGlobalDispatcher(envHttpProxyAgent)
```
Installer undici dans le dossier proxy
```bash
npm i undici
```

Puis lancer le projet avec npm en lançant le script dev.sh
```bash
./dev.sh
```

## Production

### Assembler le code pour la production

```bash
npm run build
```

### Demarrer en le serveur de production

Apres avoir assemblé le code pour la production :

```bash
npm run start
```

### Contrôler la qualité et le formatage du code

La qualité et le formatage du code sont contrôlés via [ESlint](https://eslint.org/)(pour la qualité) et [ESLint Stylistic](https://eslint.style/)(pour le formatage).

```bash
npm run lint
```

## Licence

[![Logo "Licence Ouverte / Open Licence"](https://www.etalab.gouv.fr/wp-content/uploads/2011/10/licence-ouverte-open-licence.gif)](https://www.etalab.gouv.fr/licence-ouverte-open-licence/)

Le code de ce logiciel est soumis à la licence ["Licence Ouverte / Open Licence" version 2.0](https://www.etalab.gouv.fr/wp-content/uploads/2017/04/ETALAB-Licence-Ouverte-v2.0.pdf).