Généralités

Ce projet a pour but d'implémenter le cahier des charges proposé par Code Lyoko.\
Il permet de gérer l'import d'un fichier CSV ainsi que l'export vers ce même format ou vers un format iCal.\
Il utilise les plugins Vorpal, Inquirer et Colors.

Table des matières

1. Installation
2. Commandes
   1. importCSV
   2. exportCSV
   3. exportHTML
   4. exportICAL
   5. ajouterIntervenant
   6. ajouterClient
   7. ajouterRendezVous
   8. editerClient
   9. editerIntervenant
   10. editerRendezVous
   11. supprimerClient
   12. supprimerIntervenant
   13. supprimerRendezVous
   14. stats
   15. conflit
   16. clear
   17. show
   18. help
   19. exit
   20. quit
3. Tests
4. Modules utilisés
5. Remerciements

Installation :

De façon à simplifier autant que possible l'installation pour l'utilisateur final, le fichier package.json est à jour.
Ainsi, pour installer l'application, il suffit de se placer dans le dossier de l'application et d'exécuter la commande suivante :

npm install

Puis, pour lancer l'application, il suffit d'utiliser la commande :

node app.js

Commandes :

importCSV [options] <filepath></filepath>

Permet d'importer un fichier CSV directement dans le logiciel.
options :
-c, -- client : Permet de dire que l'on importe directement un client.\
-i, --intervenant : Permet de dire que l'on importe directement un intervenant.\
Si l'option n'est pas précisée, alors un menu proposera à l'utilisateur de choisir entre les deux.

export <format> [texte]</format>

Permet d'exporter tous les rendez-vous du contact correspondant au champ [texte], ou, à défault, de tous les clients/intervenants.
L'export se fait dans le format spécifié, dont les valeurs peuvent être : "csv", "html" ou "ical".
Le fichier sera généré dans le sous-dossier /export/.

ajouterClient

Permet d'ajouter un Client.

ajouterIntervenant

Permet d'ajouter un Intervenant.

ajouterRendezVous

Permet d'ajouter un RendezVous.

editerClient

Permet de modifier un Client.

editerIntervenant

Permet de modifier un Intervenant.

editerRendezVous

Permet de modifier un RendezVous.

supprimerClient

Permet de supprimer un Client.

supprimerIntervenant

Permet de supprimer un Intervenant.

supprimerRendezVous

Permet de supprimer un RendezVous.

stats

Permet d'afficher des statistiques sur les clients, intervenants et rendez-vous importés et actuellement en mémoire.

conflit

Permet de détecter et afficher des conflits entre rendez-vous.

clear

Permet de supprimer tous les clients, intervenants et rendez-vous actuellement en mémoire, remettant "à zéro" toutes les données de l'application.

show [texte]

Permet de montrer les clients intervenants et/ou rendez-vous présents en mémoire et correspondant au champ [texte], ou, à défault, en intégralité, sans filtrage.

help

Permet d'afficher l'ensemble des commandes disponibles sur l'application.

help [commande]

Permet d'afficher la descritpion de la commande spécifiée.

exit

Permet de quitter l'application.

quit

Permet de quitter l'application.

Tests :

Le développement a été fait sous
* NodeJS 8.0.4
* Les versions des modules précisées dans le fichier package.json

Le système est conçu de façon à fonctionner sous tous les principaux terminaux,
et sous tous les environnements compatibles avec node.js.

Modules utilisés :

• Vorpal : Permet de générer l'interface CLI de l'application
• Vorpal-autocomplete-fs : Permet l'autocomplete basé sur les dossiers de l'application
• Inquirer
• uniqID
• Colors
• fs-extra : Version étendue de fs.

Remerciements :

StackOverflow