Description

Backend de l'application Agir https://agir.beta.gouv.fr/

Ce composant porte

• la persistance des données utilisateur via la BDD Postgresql
• la majeur partie de la logique métier et data du service exposée via des APIs aux clients web et mobile (les mêmes APIs pour les deux)
• l'interfaçage avec les services externes (Nos gestes climat, impactCO2, pres de chez nous, linky, etc)

Pile technique.

• Language : nodejs (>=18.0.0)
• Typescript
• Postgresql 14 en base de données
• ORM Prisma
• Nestjs comme framework principale (controlers, injection de dépendances, ...)
• Jest pour le framework de tests
• Infra de run : Scalingo.com

Installation locale

$ npm install

Configuration de la base de données locale

Le backend a besoin d'une instance Postgresql (v14) pour s'exécuter, également une instance pour exécuter l'ensemble des tests d'intégration

Vous êtes libre de configuer en local ces instance selon vos préférences :

• via une installation standalone de Postgresql
• via docker (un fichier docker-compose.yml est fournit à titre d'exemple)

Exemple d'installation de docker sous mac (optionel)

Sur mac voici une façon de faire (si vous ne pouvez pas utiliser Docker Desktop pour des questions de licence):

# Install hyperkit and minikube
brew install hyperkit
brew install minikube

# Install Docker CLI
brew install docker
brew install docker-compose

# Start minikube
minikube start

# Tell Docker CLI to talk to minikube's VM
eval $(minikube docker-env)

# Save IP to a hostname
echo "`minikube ip` docker.local" | sudo tee -a /etc/hosts > /dev/null

# Test
docker run hello-world

Paramétrage des URLs de BDD

• Dupliquer le fichier .env.run.sample en .env.run, le remplir, ce fichier est utilisé pour les run local du back, cad npm run start:dev
• Dupliquer le fichier .env.test.sample en .env.test, le remplir, ce fichier est utilisé pour les lignes de commande de test, eg. npm run test
• renseigner les URLs respectives de votre base de test base de dev

Lancer les bases de données

Si vous utilisez docker, vous avec les raccourcis suivants ;

npm run db:up
npm run db:down

Lancer les migrations sur les bases de dev et tests

Cette procédure joue l'ensemble des script SQL permettant d'avoir la dernière version du schema SQL de l'application AGIR

npm run db:update

Lancer les tests d'intégration et les tests unitaires

Pour vérifier que tout marche bien

npm run test # pour tous les tests sauf ceux appelant une API externe

npm run test:int # pour les tests d'intégration seuls

npm run test:unit # pour les tests unitaires seuls

npm run test:api # pour les tests api seuls

npm run test:ext # pour les tests faisant appel à des APIs externes

Accéder à la base scalingo de dev

Il faut utiliser un tunnel SSH pour accéder via un client local la base de données scalingo Il est nécessaire au préalable d'installer la ligne de commande Scalingo (https://doc.scalingo.com/platform/cli/start)

Il peut être également nécessaire de configurer sa clé SSH dans son compte Scalingo (https://doc.scalingo.com/platform/getting-started/setup-ssh-linux)

#Valeur de DATABASE_URL à récupérer dans l'interface web scalingo de agir-back-dev
scalingo --app agir-back-dev db-tunnel DATABASE_URL

Lancer l'application

# build project
$ npm run build

# start backend
$ npm run start

ou bien

# watch mode
$ npm run start:dev

Assistant d'écriture de CRON

https://crontab.guru/