Comprendre les principales commandes
Vue d'ensemble
Vous trouverez dans cette page la signification des principales commandes offertes par l'OIP Starter.
Commandes
entities:gen
La commande entities:gen génÚre le code des entités à partir du fichier de configuration config/entities/entities.openapi.yml.
Le code est généré dans le dossier entities. Celui-ci contient :
- un fichier entities.mjs qui contient la définition des entités ;
- un dossier pour chaque entité qui contient :
- un fichier index.mjs qui exporte les fonctions de manipulation de l'entité et l'ensemble des accesseurs (getters et setters) pour manipuler ses propriétés ;
- un fichier enums/index.mjs qui exporte les énumérations utilisées par l'entité ; ce fichier n'est présent que si l'entité utilise des énumérations.
views:gen
La commande views:gen génÚre le code des vues à partir des fichiers de configuration YAML présents dans le dossier config/views.
Le code est généré dans le dossier views. Celui-ci contient :
- un fichier views/views.mjs pour la définition de toutes les vues ;
- un dossier pour chaque vue ; chaque dossier porte le nom de la vue correspondate.
migrate:dev
La commande migrate:dev exécute le script scripts/run-migrations.sh. Ce script applique les migrations SQL présentes dans le dossier migrations.
server:dev
La commande server:dev lit les variables d'environnement depuis le fichier .env, puis exécute le fichier server/index.mjs.
start-server:dev
La commande start-server:dev exécute la commande migrate:dev puis la commande server:dev.
front:dev
La commande front:dev démarre le serveur de développement Vite.