Skip to content

Commit

Permalink
correct
Browse files Browse the repository at this point in the history
  • Loading branch information
fufeck committed Feb 27, 2024
1 parent 8e1fe70 commit b036ef1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,20 @@ https://adresse-data-gouv-fr.gitbook.io/bal/mes-adresses

### Installation

Installation des dépendances Node.js

```
yarn
```

Créer les variables d'environnement

```bash
cp .env.sample .env
```

On pourra ensuite éditer les variables d'environnement dans le fichier `.env` si nécessaire.

### Développement

Lancer l'api de développement :
Expand Down Expand Up @@ -60,10 +70,28 @@ $ yarn start:cron

### Mise a jour

Mettre a jour les liste des communes (code insee) qui ont un cadastre

```
yarn update-cadastre
```

### Test

Rapport des tests (jest) :

```
$ yarn test
```

### Linter

Rapport du linter (eslint) :

```
$ yarn lint
```

## Configuration

Cette application utilise des variables d'environnement pour sa configuration.
Expand All @@ -73,7 +101,6 @@ Elles peuvent être définies classiquement ou en créant un fichier `.env` sur
| --------------------------| --------------------------------------------------------------------------- |
| `MONGODB_URL` | Paramètre de connexion à MongoDB |
| `MONGODB_DBNAME` | Nom de la base de données à utiliser |
| `MONGODB_CERTIFICATE` | Certificat pour les db mongo qui le demande |
| `PORT` | Port à utiliser pour l'API |
| `SMTP_HOST` | Nom d'hôte du serveur SMTP |
| `SMTP_PORT` | Port du serveur SMTP |
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
"test:cron": "jest --config ./apps/cron/test/jest-e2e.json",
"test:e2e": "yarn test:api && yarn test:cron",
"update-cadastre": "node ./scripts/update-communes-cadastre.js",
"update-contours": "node ./scripts/update-contours-communes.js",
"push-staging": "./scripts/push-staging.sh"
},
"dependencies": {
Expand Down

0 comments on commit b036ef1

Please sign in to comment.