Pré-requis

9 min

Vue d'ensemble

Le développement d'un OAV suppose un poste outillé et un accès aux ressources distribuées par FASST.

Cette page recense l'ensemble des pré-requis à réunir avant d'initialiser un projet.

Catégorie	À réunir
Outils	Git, Node.js, Docker.
Dépôts	Accès en lecture au modèle de projet OIP Starter.
Paquets npm	Accès au registre privé hébergeant l'organisation @fasstech.
Images Docker	Accès aux images des services annexes.

Outils de développement

Installez et configurez les outils suivants sur votre poste :

Outil	Version	Rôle
Git	Récente	Récupération du modèle de projet et versionnement du projet.
Node.js	Dernière LTS	Exécution du serveur Express, du client Vite et d'OIP Tools.
Docker	Récente	Exécution des services annexes de l'OAV.

[info] Node.js doit être utilisé dans sa dernière version LTS. L'usage d'un gestionnaire de versions (e.g. mise) est recommandé afin d'aligner rapidement le poste sur la version attendue par le projet.

Droits d'accès

Dépôts GitHub

Vous devez disposer d'un accès en lecture au dépôt suivant :

Dépôt	Rôle
fasst/fasst-oip-starter	Modèle de projet OIP Starter, servant de point de départ à tout OAV. La branche à utiliser est v4.

Vérifiez cet accès sans cloner le dépôt :

git ls-remote [email protected]:fasst/fasst-oip-starter.git v4

Paquets npm

Les paquets de l'OIP sont publiés dans l'organisation @fasstech d'un registre npm privé. Votre poste doit être authentifié auprès de ce registre (généralement au moyen d'un fichier .npmrc) avant toute installation de dépendances.

Paquet	Rôle
@fasstech/oip-starter-utils	Socle applicatif : application React, application Express, couche GraphQL, sessions, moteurs de transitions et ordonnanceur de tâches.
@fasstech/oip-core	Bibliothèque d'accès aux données au-dessus de l'API OIP Headless.
@fasstech/oip-tools	Interface en ligne de commande de configuration et de génération de code.
@fasstech/checkenv	Validation des variables d'environnement au démarrage.
@fasstech/rabbitmq-helper	Client AMQP utilisé pour les évènements et les tâches.
@fasstech/logger	Journalisation applicative.
@fasstech/textit	Internationalisation.

Vérifiez cet accès :

npm view @fasstech/oip-tools version

Images Docker

Vous devez pouvoir télécharger les images des services annexes :

Image	Rôle
fasstech/oip-headless	Service de persistance, d'historisation, d'ordonnancement des tâches et d'application des règles RGPD.
fasstech/fasst-sessions	Service d'émission et de validation des jetons de décrochage.

Vérifiez cet accès :

docker pull fasstech/oip-headless
docker pull fasstech/fasst-sessions

[info] Ces deux services s'appuient sur PostgreSQL et RabbitMQ, dont les images sont publiques. L'ensemble est décrit dans la section « Services annexes ».

Résumé

Le poste doit disposer de Git, de Node.js en version LTS et de Docker ;

l'accès au dépôt fasst/fasst-oip-starter, au registre npm privé @fasstech et aux images Docker des services annexes est indispensable ;

vérifiez chaque accès avant d'initialiser le projet.