Ce code n'est plus d'actualité, la stack a été rappatriée sur celle de API Entreprise

---

Installation

Prérequis

• Docker
• Docker Compose
• Node.js

Étapes

• Ajouter 127.0.0.1 mon.portail.local dans votre fichier /etc/hosts
• cp .env.dist .env
• Demander à un collègue ou ami les valeurs des secrets à mettre en variable d'environnement
• docker-compose up

Attention, l'installation peut échouer si vous ne définissez pas correctement le .env, par exemple la commande de migration ne saura pas se connecter à la base de données

Une fois les containers lancés, vous pouvez préparer votre environnement de développement local en lançant les commandes suivantes sur votre machine hôte :

• npm install
• npm run migrate up
• npm run fixtures:load

Installations alternatives

Sur Github Codespace

Le projet est configuré pour être développé dans un devcontainer, et donc par extension fonctionne dans Github Codespace.

Nous supposons que vous utilisez VSCode en tant qu'IDE pour exploiter la capacité Codespace du projet.

Github Codespace se base sur les devcontainers, si vous êtes utilisateur de Github Codespace vous pouvez tout simplement créer un codespace pour le projet en allant sur sa page Github et en appuyant sur ..

Configuration

Toute la configuration se fait par variable d'environnement, selon les recommandations de Twelve-factor app.

Si vous avez choisir l'installation par Docker compose, vous n'avez rien à configurer.

Parmi les variables d'environnement notables, si vous n'avez pas choisi le mode d'installation par docker-compose, vous serez amené à modifier :

• DATABASE_URL
• TEST_DATABASE_URL

Vérifier l'installation

Afin de vous assurer que vous êtes prêts à développer sur le projet, vous pouvez lancer les tests suivants depuis votre machine hôte :

• npm run type-check
• npm test
• npm run test:integration

Si vous êtes utilisateur de VSCode, vous pouvez également utiliser l'extension REST Client afin d'exploiter le fichier api.http présent à la racine du projet.

Ce fichier recense tous les appels usuels à l'API qui vous seront utiles pour tester vos développements en local et en recette.

Développement

Bac à sable ou appels aux fournisseurs de donnée ?

L'API possède deux modes de fonctionnement, choisis selon la variable d'env SANDBOXED :

• SANDBOXED=true : mode bac à sable, l'API n'appelle pas les fournisseurs de donnée et se base sur les données Airtable
• SANDBOXED=false : mode réel, l'API appelle les fournisseurs de donnée

Lancement de l'application

L'application possède deux couches de présentation principales :

• l'API et le backend, lancés par la commande npm run start:dev:backend
• le frontend, sous la forme du portail développeur, lancé par la commande npm run start:dev:frontend

Afin de lancer les deux couches de présentation en mode développement, exécutez la commande suivante sur votre machine hôte :

• npm run start:dev

Une fois l'application démarrée, vous pouvez vous rendre sur https://mon.portail.local:3000 afin de récupérer votre jeton d'API.

Tests

L'application possède 4 niveaux de test :

• npm run type-check : analyse statique de types
• npm test : tests unitaires
• npm run test:integration : tests d'intégration
• npm run test:end-to-end : tests end-to-end, lancés principalement sur la CI

Déploiement

L'application est exécutée sur Dokku, le déploiement se fait par des git push sur les bons remotes.

Un remote correspond à un environment, vous devez donc les ajouter à votre repo local pour pouvoir ensuite déployer :

• git remote add sandbox-staging [email protected]:particulier-test-staging.api.gouv.fr
• git remote add sandbox-production [email protected]:particulier-test.api.gouv.fr
• git remote add staging [email protected]:particulier-staging.api.gouv.fr
• git remote add production [email protected]:particulier.api.gouv.fr

Vous pouvez alors déployer sur les différents environnements :

• Bac à sable de staging : git push sandbox-staging
• Bac à sable de production : git push sandbox-production
• API de staging : git push staging
• API de production : git push production

Administration

Forest Admin est utilisé pour gérer les fournisseurs de services dans l'API Particulier. Créez-vous un compte afin de pouvoir accéder à l'interface, puis demandez à un collègue ou ami de vous inviter sur l'interface d'administration.

Mettre à jour le schéma ForestAdmin suite à une migration de base de données

• npx -p forest-cli forest schema:update --config=src/presentation/admin/config/databases.js --outputDirectory=src/presentation/admin2
• cp -R src/presentation/admin2/* src/presentation/admin/
• npx eslint --fix src/presentation/admin
• manually fix the remaining linting issues
• rm -rf src/presentation/admin2
• npm run start:dev:backend to update the .forestadmin-schema.json file

Fonctionnement

Tâches de run

Certaines tâches interviennent fréquemment dans le run du produit, lorsqu'elles deviennent trop fréquentes, il convient de s'outiller.

Envoyer les flux XML à la CNAF pour débugage de leur API

La CNAF nous demande fréquemment le contenu des flux XML d'échange avec leur API, pour certains identifiants. Cette tâche est outillée par une CLI :

npm run cnaf:debug -- -a numeroAllocataire -c codePostal