WIKI YADOM
GUIDE UTILISATEUR
INSTALLATION
- se positionner dans le repertoire de la bibliothèque
- taper "npm install" pour installer les dépendances
UTILISATION
Taper sur l'invite de commande : node YADomCli.js <commande></commande>
Liste des commandes disponibles:
- readme : permet d'afficher le ReadMe
- convert <type fichier="" entrée=""> <fichier à="" convertir=""> : permet de passer du format csv au format ics et vice versa.</fichier></type>
- chart <type fichier="" entrée=""> <fichier en="" entrée=""> : génère un rapport graphique au format HTML et lisible via firefox.</fichier></type>
- help : obtenir de l'aide
Une fois la commande charts utilisée, il suffit de lancer le fichier charts.html inclus dans le dossier pour afficher l'emploi du temps.
GUIDE DEVELOPPEUR
ORGANISATION PROGRAMME
- YADomCli.js : fichier regroupant les commandes du programme. Caporal est utilisé comme module
- README.MD : fichier readme semblable au guide utilisateur
- fichiers .ical et .csv : fichiers de test pour utiliser le programme
- CsvParser.js ; permet de parser un fichier au format .csv pour pouvoir ensuite le convertir ou afficher en chart
- iCalModule.js : permet de parser un fichier .ical via le module [ical.js] (https://www.npmjs.com/package/ical.js)
- chartGenerator.js : permet de générer le chart d'après un .ical ou .ics
- checkConflictSchedules.js : permet de vérifier si 2 plannings ont un créneau commun.
- chartsGenerated.js : contient la data pour afficher un tableau grâce à GoogleCharts
- charts.html : page HTML à executer pour afficher le planning
PISTE EVOLUTION
- L'utilisation d'un fichier .json pourrait être pertinent. Cela permettrai de stocker les plannings importés (.ical ou .ics) et ainsi unifier les plannings sous forme d'un objet
- Rendre plus clair les actions effectuées par le programme : améliorer l'affichage via l'utilisation de couleurs et indiquer textuellement les actions faites
Project Members: