Documentation technique

1. Installation et exécution

Pour exécuter ce logiciel, il est nécessaire d’avoir au préalable installé sur l’ordinateur, la plateforme logiciel « NodeJs » ainsi que les packages « fs », « iCal » et « readline-sync ».

Pour installer « NodeJs », il faut se rendre sur le site officiel https://nodejs.org/en/ et y télécharger la dernière version. L’installation peut donc se faire sous n’importe quel système d’exploitation.

Une fois « NodeJs » installé sur votre machine, pour installer les packages nécessaires, il suffit de saisir la commande : npm install « nomDuPackage ».

Enfin, pour lancer le programme, il suffit d’exécuter la commande : node main.js

---

2. Description

Le projet est un gestionnaire de plannings aux formats iCal et planinfo (format utilisé par l'entreprise YAdom).
Un planning contient des interventions entre un intervenant et un bénéficiaire.
Une intervention se définit par une date de début, une durée, un intervenant, un bénéficiaire et son lieu d'intervention.
Un planning correspond aux interventions d'une semaine pour un bénéficiaire ou un intervenant.
Les plannings de l'application doivent tous être stockés dans le dossier "./database/", et sont tous stockés au format planinfo.

---

3. Fonctionnalitées

• Importer un planning au format iCal ou planinfo. Dans le cas de l'import d'un planning au format iCal, il sera converti au format planinfo avant d'être enregistré dans "./database/"
• Exporter un planning du format iCal au format planinfo ou inversement. Le planning exporté sera enregistré dans le dossier "./exports"
• Afficher le planning de la semaine d'un intervenant ou d'un bénéficiaire
• Ajouter une intervention entre un intervenant et un bénéficiaire
• Supprimer une intervention existante dans "./database/"
• Mettre à jour une intervention existante dans "./database/"
• Afficher les plannings qui contiennent une intervention en conflit avec une intervention choisie par l'utilisateur

---

4. Description du code

Le code est structuré en 3 dossiers et regroupe un ensemble de fichiers à la racine du projet (dossier project4you).

Les dossiers :

Le dossier database :
Dossier regroupant l'ensemble des informations des plannings des bénéficiaires et des intervenants.

Le dossier exports : **
Dossier regroupant l'ensemble des fichiers exportés aux formats iCalendar ou planInfo.

Le dossier node_modules : **
Dossier regroupant l'ensemble des modules nécessaires à la bonne utilisation de nodeJs.

Le dossier tests : **
Dossier regroupant l'ensemble des fichiers de tests pour les plannings (format PlanInfo et iCalendar).

Et les fichiers présents à la racine du projet :

Le fichier affichagePlanning.js : **
Fichier permettant l'affichage d'un planning intervenant ou bénéficiaire.

Le fichier affichagePlanningBeneficiaire.js :
Fichier qui gère l'affichage d'un planning bénéficiaire selon un bénéficiaire choisi (voir affichagePlanning.js).

Le fichier affichagePlanningIntervenant.js : **
Fichier qui gère l'affichage d'un planning intervenant selon l'intervenant choisi (voir affichagePlanning.js).

Le fichier ajoutIntervention.js :
Fichier qui gère l'ajout d'une intervention selon plusieurs informations (choix d'un intervenant, d'un bénéficiaire, d'une date d'intervention et d'un créneau d'intervention).

Le fichier exportPlanning.js : **
Fichier qui gère l'export d'un planning.

Le fichier importPlanning.js : **
Fichier qui gère l'import d'un planning.

Le fichier intervention.js : **
Fichier qui représente une intervention avec toutes ses caractéristiques (date, durée, intervenant, bénéficiaire, lieu et la profession de l'intervenant).

Le fichier main.js : **
Fichier qui représente le point d'entrée du programme et qui gére la présentation du menu principal de l'application proposant à l'utilisateur de choisir quelle fonction utiliser.

Le fichier miseAJourIntervention.js : **
Fichier qui gère la mise à jour d'une intervention dans le planning bénéfiaire et intervenant correspondant.

*Le fichier planinfoParserBeneficiaire.js : **
Fichier qui gère la récupération des données d'un bénéficiaire présent dans un fichier au format planInfo selon une grammaire précise. *

*Le fichier planinfoParserIntervenant.js : **
Fichier qui gère la récupération des données d'un intervenant présent dans un fichier au format planInfo selon une grammaire précise. *

Le fichier supprimerIntervention.js : **
Fichier qui gère la suppresion d'une intervention dans le planning bénéficiaire et intervenant correspondant.

Le fichier updateIntervention.js : **
Fichier qui gère la mise à jour d'une intervention dans le planning bénéfiaire et intervenant correspondant.

Le fichier visionnerDeuxPlanningsConflits.js :
Fichier qui vérifie si le planning d'un intervenant ou d'un bénéficiaire est en conflits avec d'autres.

Le fichier LICENSE.txt : **
Fichier de copyright.

Le fichier README.txt :
Fichier qui présente l'utilisation du logiciel.