diplomatiegouvfr / generator-hornet-js-lite-batch

Template de création de la partie nodejs de Hornet Lite Batch

generator-hornet-js-lite-batch

Description

Le module Node « generator-hornet-js-lite-batch » contient les éléments de création d'une application Hornet JS Lite Batch. Il est utilisable avec Yeoman.

Pré-requis

• NodeJS 10.X
• hornet-js-builder : 2.X.X installé en global:

    $ npm install -g hornet-js-builder

Utilisation

Yeoman

Yeoman est un outil permettant de construire des outils de génération de projets. Celui-ci s'appuie sur plusieurs composants dont Yo qui s'occupe plus spécifiquement de l'aspect génération.

Hornet JS propose un générateur d'application basé sur Yo.

Pour installer Yeoman, exécuter la ligne de commande suivante :

$ npm install -g yo

Installation du générateur

$ npm install -g generator-hornet-js-lite-batch

Initialisation d'un projet

Tout d'abord, il vous faut créer un dossier pour accueillir votre nouveau projet :

$ mkdir nom_de_l_application
$ cd nom_de_l_application

Dans le répertoire destiné à accueillir le code de l'application, exécuter la ligne de commande suivante pour débuter la génération d'un nouveau projet basé sur hornet-js-lite-batch :

$ yo hornet-js-lite-batch

Le générateur va vous demander plusieurs informations nécessaires à l'initialisation de votre projet Hornet JS :

• Nom de votre projet: (nom_de_l_application) : par défaut, le nom du répertoire est suggéré comme nom technique du projet
• Version de votre projet: (1.0.0) : version du projet (1.0.0 par défaut).
• Description de votre projet : un texte court présentant succintement le projet.
• Version du framework (hornet-js): (5.x.x) : version du framework hornet-js (5.x.x par défaut identique à generator-hornet-js).
• ContextPath de la partie batch (batch : terme utilisé dans les routes après le nom de l'application (ex http://localhost:8888/nom_de_l_application/batch/nom_de_la_route)

Le processus d'initialisation vous indique ensuite les fichiers créés :

Options avancées

Paramètre nom du projet

Il est possible de fournir directement le nom du projet à la ligne de commande :

$ yo hornet-js-lite-batch nom_de_l_application

Dans ce cas, la première question n'est pas posée et la valeur passée en paramètre est utilisée.

Actions post-génération

Récupération des dépendances

Une fois le projet initialisé, vous devez lancer l'installation des dépendances Node.js avec la commande suivante :

$ hb install

Configuration

Si vous souhaitez modifier la configuration de l'application, vous pouvez éditer le fichier suivant :

• config\default.json

Démarrage de l'application

Pour exécuter votre nouvelle application, utilisez la commande suivante :

$ npm start

Puis, utiliser un navigateur web pour y accéder par l'url [http://localhost:8888/nom_de_l_application/batch/nom_de_la_route].

Licence

generator-hornet-js_lite_batch est sous licence cecill 2.1.

Site web : http://www.cecill.info