fix: README

.env.sample

@@ -1,29 +1,32 @@
 NEXT_PUBLIC_BAL_ADMIN_URL=https://bal-admin.anct.gouv.fr
 NEXT_PUBLIC_API_MOISSONEUR_BAL=https://plateforme-bal.adresse.data.gouv.fr/moissonneur
-API_MOISSONEUR_BAL_TOKEN=
-NEXT_PUBLIC_API_DEPOT_URL=https://plateforme-bal.adresse.data.gouv.fr/api-depot
-API_DEPOT_TOKEN=
-NEXT_PUBLIC_API_DEPOT_DEMO_URL=https://plateforme-bal.adresse.data.gouv.fr/api-depot-demo
-API_DEPOT_DEMO_TOKEN=
-NEXT_PUBLIC_API_MES_ADRESSES=https://api-bal.adresse.data.gouv.fr/v1
+NEXT_PUBLIC_API_MES_ADRESSES=https://api-bal.adresse.data.gouv.fr/v2
 NEXT_PUBLIC_MES_ADRESSES_URL=http://mes-adresses.data.gouv.fr
 NEXT_PUBLIC_API_GEO=https://geo.api.gouv.fr
 NEXT_PUBLIC_API_BAN_URL=https://plateforme.adresse.data.gouv.fr
 NEXT_PUBLIC_API_DEPOT_DEMO_URL=http://localhost:8001
+NEXT_PUBLIC_API_DEPOT_URL=https://plateforme-bal.adresse.data.gouv.fr/api-depot
+NEXT_PUBLIC_BAL_WIDGET_URL=https://baseadressenationale.github.io/bal-widget/
+
+API_MOISSONEUR_BAL_TOKEN=
+API_DEPOT_TOKEN=
 API_DEPOT_DEMO_TOKEN=
 API_MES_ADDRESSES_TOKEN=
+HCAPTCHA_SECRET_KEY=
 MONGODB_URL=mongodb://localhost:27017
 MONGODB_DBNAME=bal-admin
+PORT=
+
 SMTP_HOST=
 SMTP_PORT=
 SMTP_SECURE=
 SMTP_USER=
 SMTP_PASS=
 SMTP_FROM=
+
 KEYCLOAK_ISSUER=
 KEYCLOAK_CLIENT_ID=
 KEYCLOAK_CLIENT_SECRET=
 NEXTAUTH_URL=
 NEXTAUTH_SECRET=
-HCAPTCHA_SECRET_KEY=
-NEXT_PUBLIC_BAL_WIDGET_URL=https://baseadressenationale.github.io/bal-widget/
+

README.md

@@ -1,37 +1,93 @@
-# gpf-geocodeur
-Géocodeur de fichiers d'adresses de la Géoplateforme
+# Bal admin
+
+Back office et permet d'administrer mes-adresses-api, moissoneur et api-depot.
+
+## Documentation
+
+https://adresse-data-gouv-fr.gitbook.io/bal/bal-admin
 
 ## Pré-requis
 
 - [Node.js](https://nodejs.org) 18+
 - [yarn](https://www.yarnpkg.com)
+- [MongoDB](https://www.mongodb.com) 4+
+
+## Utilisation
 
-## Installation
+### Installation
 
 Installation des dépendances Node.js
 
 ```
 $ yarn
 ```
 
-## Développement
+### Développement
 
 Lancer le serveur de développement :
 
 ```
 $ yarn dev
 ```
 
-## Production
+### Production
 
 Créer une version de production :
 
 ```
 $ yarn build
 ```
 
-Démarrer le serveur (port 3000 par défaut) :
+Démarrer le serveur (port 9000 par défaut) :
 
 ```
 $ yarn start
 ```
+
+### Linter
+
+Rapport du linter (eslint) :
+
+```
+$ yarn lint
+```
+
+## Configuration
+
+Cette application utilise des variables d'environnement pour sa configuration.
+Elles peuvent être définies classiquement ou en créant un fichier `.env` sur la base du modèle `.env.sample`.
+
+| Nom de la variable   | Description                                                                 |
+| -------------------- | --------------------------------------------------------------------------- |
+| `NEXT_PUBLIC_BAL_ADMIN_URL` | URL de base de bal admin |
+| `NEXT_PUBLIC_API_MOISSONEUR_BAL` | URL de base de l'api du moissonneur |
+| `NEXT_PUBLIC_API_MES_ADRESSES` | URL de base de mes-adresses-api |
+| `NEXT_PUBLIC_MES_ADRESSES_URL` | URL de base de mes-adresses |
+| `NEXT_PUBLIC_API_GEO` | URL de base de l'api-geo |
+| `NEXT_PUBLIC_API_DEPOT_URL` | URL de base de l'api de depot |
+| `NEXT_PUBLIC_API_DEPOT_DEMO_URL` | URL de base de l'api de depot demo |
+| `NEXT_PUBLIC_BAL_WIDGET_URL` | URL de base du Bal widget |
+|---|---|
+| `MONGODB_URL`             | Paramètre de connexion à MongoDB                                            |
+| `MONGODB_DBNAME`          | Nom de la base de données à utiliser                                        |
+| `PORT`                    | Port à utiliser pour l'API                                                  |
+| `API_MOISSONEUR_BAL_TOKEN` | TOKEN admin du moissoneur |
+| `API_DEPOT_TOKEN` | TOKEN admin de l'api de depot |
+| `API_DEPOT_DEMO_TOKEN` | TOKEN admin de l'api de depot demo |
+| `API_MES_ADDRESSES_TOKEN` | TOKEN admin de mes-adresses-api |
+| `HCAPTCHA_SECRET_KEY` | Clef secrete du captcha |
+|---|---|
+| `SMTP_HOST`               | Nom d'hôte du serveur SMTP                                                  |
+| `SMTP_PORT`               | Port du serveur SMTP                                                        |
+| `SMTP_USER`               | Nom d'utilisateur pour se connecter au serveur SMTP                         |
+| `SMTP_PASS`               | Mot de passe pour se connecter au serveur SMTP                              |
+| `SMTP_SECURE`             | Indique si le serveur SMTP nécessite une connexion sécurisée (`YES`)        |
+| `SMTP_FROM`               | Adresse à utiliser en tant qu'expéditeur des emails                         |
+|---|---|
+| `KEYCLOAK_ISSUER`         | Isseur du keycloack |
+| `KEYCLOAK_CLIENT_ID`      | Id du client Keycloack |
+| `KEYCLOAK_CLIENT_SECRET`  | Secret du client Keyclack|
+| `NEXTAUTH_URL`            | Url de connection NextJs |
+| `NEXTAUTH_SECRET`         | Secret de connection NextJs |
+
+Toutes ces variables ont des valeurs par défaut que vous trouverez dans le fichier `.env.sample`.