Lancement du projet

12 min

Démarrer le projet en local

Ce template nécessite les services suivants :

Une base de données MongoDB

Le service fasst-sessions, pour assurer le bon fonctionnement des sessions

Un service RabbitMQ, requis pour le support des subscriptions GraphQL

Le fichier docker-compose.yml situé à la racine de ce repository expose ces services. Vous êtes libre de l’utiliser tel quel ou de configurer votre environnement local selon vos préférences.

Variables d'environnement

cp .env.dist .env

Variables générales

Variable	Description
ROOT_DIR	chemin du répertoire racine du projet, utilisé comme base pour les chemins relatifs. Valeur par défaut : . (répertoire courant)
PORT	numéro du port sur lequel le serveur écoute les requêtes entrantes.
NODE_ENV	définit l’environnement d’exécution de l’application.

Variables demandées par l'OIP Core

Variable	Description
OIP_WORK_DIR	Chemin relatif vers le répertoire de travail utilisé par OIP Core.
OIP_MONGO_DB_URL	URL de connexion à la base de données MongoDB utilisée par l’application.
CIPHER_IV	Vecteur d’initialisation utilisé par l’algorithme de chiffrement d’OIP Core.
CIPHER_KEY	Clé de chiffrement utilisée par l’algorithme de sécurité d’OIP Core.

Variables liées à la logique de session

Variable	Description
SESSIONS_SERVICE_URL	URL du service fasst-sessions, utilisé pour la gestion des sessions utilisateur.
SESSION_COOKIE_MAX_AGE	Durée de validité du cookie d’authentification, exprimée en minutes. Valeur par défaut : 60
SESSION_SECRET	Chaîne secrète utilisée pour signer l’ID du cookie de session (HMAC).
SESSION_CHECKING_DISABLED	Si cette variable est définie à true, la vérification du token auprès du service fasst-sessions est désactivée. &#xNAN;⚠️ À utiliser uniquement en environnement de développement ou pour des tests.

Variables liées à la logique d'authentification

Variable	Description
API_USER_ID	Variable nécessaire pour la logique d'authentification
API_KEY	Variable nécessaire pour la logique d'authentification
API_KEYS	Variable nécessaire pour la logique d'authentification
JWT_SECRET	Variable nécessaire pour la logique d'authentification

Variables demandées par l'OIP Tools

Variable	Description
TOKEN_READONLY_OIP_API ou OIP_TOOLS_CLIENT_SECRET	Variable requise par OIP Tools

Variables liées à la logique de connexion à RabbitMQ

Variable	Description
RABBIT_MQ_QUEUE_NAME	Le nom de la queue
RABBIT_MQ_HOST	Nom de l'host
RABBIT_MQ_VHOST	Nom du virtual host
RABBIT_MQ_UI_PORT	Port d'écoute de l'interface graphique
RABBIT_MQ_USER	Le nom de l'utilisateur
RABBIT_MQ_PASSWORD	Le mot de passe

Démarrer le server en local

Depuis la racine du projet :

npm run server:dev

Démarrer l'application en local

Depuis la racine du projet :

npm run front:dev

URL par défaut : http://localhost:8000

Build des views

Depuis la racine du repository

npm run views:build

Initialiser une session

En local, pour désactiver la vérification du token auprès du service fasst-sessions, définissez la variable d'environnement SESSION_CHECKING_DISABLED sur true

Générez un token depuis le service fasst-sessions, exemple :

curl --request POST \
  --url http://localhost:3000/api/sessions/tokens \
  --header 'Content-Type: application/json' \
  --data '{
  "applicant": "magic",
  "metadata": {
    "externalId": "project-AAA"
  }
}'

Ensuite, insérez le jeton reçu en paramètre dans l’URL de l’application, comme suit : http://localhost:8000/?token=my-beautiful-token

Et voilà ! Votre session est désormais initialisée, vous êtes prêt à naviguer dans votre parcours.