[NEW] Initialiser un projet

10 min

Initialiser un projet

La commande init permet d’initialiser un projet OIP.

Elle génère l’ensemble minimal des fichiers nécessaires au démarrage du projet et prépare la structure technique attendue par l’application.

La commande peut également générer une première vue si un nom de vue est fourni via l’option --first-view-name.

Utilisation

oip-tools init --oav-name <nom-oav>

Il est également possible d’indiquer une première vue à générer lors de l’initialisation :

oip-tools init --oav-name <nom-oav> --first-view-name <nom_vue>

Options

Option	Description	Obligatoire
--oav-name <nom-oav>	Nom de l’OAV à initialiser.	Oui
--first-view-name <nom_vue>	Nom de la première vue à générer dans le parcours.	Non

Modèle de données initial

Lors de l’initialisation, le modèle de données du projet est créé avec une structure minimale.

Par défaut, ce modèle contient une entité Project avec une propriété externalId de type string.

Cette structure permet de disposer d’un socle minimal exploitable dès le démarrage du projet, notamment pour répondre au besoin initial de décrochage.

Effets de la commande

La commande init peut générer ou mettre à jour plusieurs fichiers nécessaires au projet.

Elle peut notamment créer ou modifier :

le fichier de configuration des entités ;

les fichiers de manipulation des entités dans le dossier entities ;

le fichier de migration initial dans le dossier migrations ;

le fichier .env, généré à partir du fichier .env.dist si le fichier .env est absent ;

le fichier index.html, notamment pour injecter le nom de l’OAV dans la balise <title>.

Selon le mode de génération utilisé par le projet, la configuration des entités peut être générée au format entities.config.mjs ou entities.openapi.yml.

La commande déclenche également la génération des entités nécessaires au projet.

Fichiers générés

Après exécution de la commande, la structure générée peut contenir les éléments suivants :

Project Root/ ├── config/ │ ├── entities/ │ │ └── entities.config.mjs │ └── views/ │ └── 0000-MY-FIRST-VIEW.yml ├── entities/ │ ├── Project/ │ │ └── index.mjs │ └── entities.mjs ├── migrations/ │ └── 0000000000000_migration.js ├── transitions/ │ └── MY_FIRST_VIEW.mjs ├── views/ │ └── my-first-view/ │ ├── client/ │ │ └── ... │ └── server/ │ └── ... ├── .env └── index.html

Cette arborescence peut varier selon les options utilisées et la configuration du projet.

Génération d’une première vue

Si l’option --first-view-name est renseignée, la commande peut également générer les éléments nécessaires à une première vue.

Elle peut notamment créer ou mettre à jour :

le fichier de configuration de la première vue dans config/views ;

le fichier de transition associé dans le dossier transitions ;

les fichiers client et serveur de la vue dans le dossier views ;

le fichier server/index.mjs, si nécessaire.

La commande peut ensuite lancer la génération des vues afin de créer les fichiers associés à cette première vue.

Format attendu pour le nom de la première vue

La valeur passée à l’option --first-view-name doit respecter le format suivant :

^[a-z0-9]+(_[a-z0-9]+)*$

Cela signifie que le nom de la vue doit être écrit en minuscules, avec des chiffres autorisés, et peut contenir des underscores entre les mots.

Exemple

oip-tools init --oav-name demo-oav --first-view-name home

Dans cet exemple, la commande initialise un projet OIP pour l’OAV demo-oav et génère une première vue nommée home.

Remarques

La commande doit être exécutée depuis le dossier du projet concerné.

Avant de lancer la commande, vérifiez que les prérequis techniques sont bien respectés, notamment la version de Node.js et l’accès aux services nécessaires.

Si un fichier .env est déjà présent, il est recommandé de vérifier son contenu avant toute modification.

Après génération, vérifiez également les fichiers de migration, les fichiers d’entités et les éventuels fichiers de vue créés par la commande.