L'API de Signalement permet de centraliser les demandes de corrections sur les adresses présentent dans la BAN et de les mettre à disposition des communes et producteurs de données adresse.
A venir
- Node.js 18+
- yarn
- PostgreSQL 12+
Installation des dépendances Node.js
yarn
Créer les variables d'environnement
cp .env.sample .envOn pourra ensuite éditer les variables d'environnement dans le fichier .env si nécessaire.
Afin d'initialiser la base de données, utiliser le flag SYNCHRONIZE_DB=true dans le fichier .env. Attention, une fois la base de données initialisée, il faut utiliser des migrations pour mettre à jour les schémas.
$ yarn dev
Créer une version de production :
$ yarn build
Démarrer l'application (port 7000 par défaut) :
$ yarn start
Rapport des tests (jest) :
$ yarn test
Rapport du linter (eslint) :
$ yarn lint
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 |
|---|---|
POSTGRES_URL |
URL de connexion à PostgreSQL |
MES_ADRESSES_URL |
URL de mes-adresses |
MES_ADRESSES_API_URL |
URL de mes-adresses-api |
MES_ADRESSES_API_TOKEN |
Token admin mes-adresses-api |
ADMIN_TOKEN |
Token admin (à générer) |
FRIENDLY_CAPTCHA_SITE_KEY |
Site key Friendy Captcha |
FRIENDLY_CAPTCHA_SECRET |
Secret Friendly Captcha |
SMTP_URL |
URL de connexion au serveur SMTP |
SMTP_FROM |
Expéditeur SMTP |
PORT |
Port de l'api |
MIT