Utilisateur

Ce wiki vous permettra de comprendre comment utiliser le logiciel de l’équipe CodeKillers.

Déjà, vous devrez installer trois choses pour garantir le bon fonctionnement du logiciel :
- npm install caporal
- npm install fs
- npm install colors

Une fois sur le bon fichier, nous devrons écrire « node main » pour voir l’ensemble des fonctionnalités proposés dans ce logiciel.

Nous allons maintenant lister les commandes possibles, leur utilisation et leur but.
-AddPlanning, utilisée avec node main AddPlanning <typePersonne>
avec typePersonnes = i pour intervenant et b pour bénéficiaire.
Cette commande crée un planning à partir d’un nom, d’un prénom et d’un domaine pour un intervenant, et à partir d’un prénom, d’un nom et d’une adresse pour un bénéficiaire.

• SupprPlanning, utilisée avec node main SupprPlanning <typePersonne> <nom>
  avec typePersonnes = i pour intervenant et b pour bénéficiaire
  nom = le nom du planning à supprimer.
  Cette commande supprime un planning d’un intervenant ou d’un bénéficiaire à partir de son nom.

• ModifyInfos, utilisée avec node main ModifyInfos <typePersonne>
  avec typePersonnes = i pour intervenant et b pour bénéficiaire
  nomPersonne = le nom de la personne à qui on veut modifier le planning.
  Cette commande modifie un planning à partir d’un nom d’un intervenant ou d’un bénéficiaire.

• AddIntervention, utilisée avec node main AddIntervention <nomBeneficiaire> <nomIntervenant> <jour> <heureDebut> <heureFin>
  avec nomBeneficiaire = le nom du bénéficiaire
  nomIntervenant = le nom de l’intervenant
  jour = le jour de l’intervention (lundi, mardi, mercredi, jeudi, vendredi, samedi ou dimanche)
  heureDebut = l’heure du début (en format HHhMM avec MM = 00 ou 30 (interventions en créneaux de 30 minutes))
  heureFin = l’heure de fin (même format que l’heure du début)i pour intervenant et b pour bénéficiaire.
  Cette commande crée une intervention à partir d’un bénéficiaire et d’un intervenant, à un jour et une heure donnée.

• SupprInter, utilisée avec node main SupprInter <nom> <jour> <heureDebut> <type>
  avec nom = nom du bénéficiaire ou de l’intervenant
  Jour = jour de l’intervention
  heureDebut = heure du début de l’intervention
  type = i pour intervenant et b pour bénéficiaire
  Cette commande supprime une intervention à partir d’un non, d’un jour et d’une heure.

• ExporterPlanningCSV, utilisée avec node main ExporterPlanningCSV <fichier> <typePersonne>
  avec fichier = fichier à exporter
  typePersonnes = i pour intervenant et b pour bénéficiaire
  Cette commande exporte un fichier de la base de donnée du logiciel en format ical.

• ComparerPlanning, utilisée avec node main ComparerPlanning <fichier> <jour> [fichier1] [fichier2] [fichier3]
  avec fichier = base de donnée à utiliser pour la comparaison (planningBeneficiaire.json ou planningIntervenant.json)
  jour = jour de la comparaison
  Cette commande compare plusieurs fichiers au format .gdoc

• ImporterPlanning, utilisée avec node main ImporterPlanning <planningcsv> <typePlanning>
  avec planningcsv = fichier au format csv à importer
  typePlanning = i pour intervenant et b pour bénéficiaire
  Cette commande importe un fichier local en .csv dans la base de donnée du logiciel.

• googleChart, utilisée avec node main googleChart
  Cette commande crée une vue google chart de la base de donnée pour mieux visualiser les conflits.

• display, utilisée avec node main display <type>
  avec type = i pour intervenant et b pour bénéficiaire
  Cette commande affiche une des deux base de donnée.

Dans l'espoir de vous avoir aidé.