Ce projet pour les BTS SIO (2e année) du lycée Aristide Bergès (Isère) peut être utilisé pour démarrer un projet complet de CRUD pour une application.
Le projet utilise les éléments suivants :
- Node.JS
- Express.JS
- EJS
- Mongoose
- JSDoc
Les étapes d'installation sont :
- git clone https://github.com/droumanet/ExpressTemplate.git
- npm install
- node app.js
Ce projet utilise une base de données 'Hopital' déjà utilisée lors d'une séance de cours précédente. Si vous utilisez la base vue en cours, elle contiendra 2 collections : medecins et salles
medecins:
| nom | specialite | ville | CP | Telephone |
|---|---|---|---|---|
| NORRIS | poingologue | TexasLand | 00000 | {fixe: "555-3345", mobile: ""} |
La base peut-être vide et ne pas contenir de collection, car MongoDB va créer les collections dynamiquement (lors de l'insertion de données).
L'application utilise le design pattern MVC. Bien que ce ne soit pas nécessaire, le découpage est poussé à l'extrême.
Pour chaque partie (domaine ou fonction) de l'application On trouve donc un routeur, un contrôleur, un modèle et des vue. L'arborescence est donc la suivante :
Express-Template |__ controllers |__ docs |__ models |__ node_modules |__ public |__ views
Les vues sont écrites pour EJS, on trouve notamment :
- un entête : il contient notamment le menu de navigation, la partie HTML + HEAD
- un pied de page : il contient les mentions légales, la licence du logiciel, etc.
- les différentes vues qui importent l'entête et le pied de page
Les contrôleurs sont des fichiers JS ayant le nom de la fonction suivie de 'Ctrl'. Exemple : medecinsCtrl.js
Le projet peut n'être utilisé qu'en partie. Cependant, les éléments suivants ont été ajoutés pour fournir un environnement complet
En utilisant la commande npm avec l'option --save-dev
npm install --save-dev jsdoc
Puis en ajoutant un fichier de configuration spécifique à JSDoc :
jsdoc.conf.json
Enfin, en utilisant la commande suivante pour "compiler" la documentation dans le répertoire docs
node node_modules/jsdoc/jsdoc.js -r -c jsdoc.conf.json app.js