https://github.com/yassinedoghri/clearwater-vcard
ClearWater permet d’importer une liste de contacts fournis au format vcf (vCard), d’effectuer des opérations dessus et d'exporter une nouvelle liste au format csv.
https://github.com/yassinedoghri/clearwater-vcard
javascript nodejs school-project vcard vcard-parser vcf
Last synced: about 2 months ago
JSON representation
ClearWater permet d’importer une liste de contacts fournis au format vcf (vCard), d’effectuer des opérations dessus et d'exporter une nouvelle liste au format csv.
- Host: GitHub
- URL: https://github.com/yassinedoghri/clearwater-vcard
- Owner: yassinedoghri
- License: mit
- Created: 2017-10-20T20:10:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-20T21:14:40.000Z (over 7 years ago)
- Last Synced: 2025-02-10T04:23:42.132Z (4 months ago)
- Topics: javascript, nodejs, school-project, vcard, vcard-parser, vcf
- Language: JavaScript
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ClearWater | Dionysos
==============
###### Projet GL02 [UTT](http://www.utt.fr/)
### Description
L'application ClearWater a été développé à partir du cahier des charges soumis par le groupe Dionysos dans le cadre de l’UV GL02 à l’UTT.
Cette solution logicielle permet d’importer une liste de contacts fournis au format vcf (vCard), d’effectuer des opérations dessus et renvoyer une nouvelle liste au format csv. Conformément au cahier des charges, la solution logicielle a pour première fonctionnalité de pouvoir traiter des fichiers vCard en entrée. Par ailleurs, la deuxième fonctionnalité de cette solution consiste à identifier les doublons présents au sein des profils. Ensuite, la fonctionnalité suivante vise à trouver des incohérences au sein des profils jumelés. A cela s’ajoute une quatrième qui consiste à fusionner les profils similaires. La cinquième fonctionnalité de cette solution vise à permettre à l’utilisateur de choisir quelles informations sont à conserver lorsqu’il demande la fusion de plusieurs profils entre eux. Enfin, la dernière fonctionnalité de cette solution correspond à l’exportation de la nouvelle liste de contacts traités au format CSV.
### Format des données
Afin d’assurer le bon fonctionnement de la solution logicielle, il est demandé à l’utilisateur de présenter les contacts au sein de la liste fournie conformément au format d’entrée (précisé ci-dessous).
###### Les données en entrée seront au format vCard (*.vcf) :
```
VCARD = ‘BEGIN:VCARD’ CRLF ’VERSION:4.0’ CRLF CONTACT CRLF ’END:VCARD’
CONTACT = NP CRLF ORGANISATION CRLF FONCTION CRLF 1*TELEPHONE CRLF 1*MOBILE CRLF COURRIEL
NP = 'N:’ TEXT ‘;’ TEXT
ORGANISATION = ’ORG:’ TEXT *(‘;’TEXT)
FONCTION = ‘TITLE:’ TEXT *(‘;’TEXT)
TELEPHONE = ‘TEL;TYPE=‘.(‘home’/‘work’).’,voice;uri=:tel:+’ 11DIGIT
COURRIEL = ‘EMAIL:’ 1*VCHAR.’@‘1*VCHAR’.’1*VCHAR
TEXT = 1*(WSP/VCHAR)
```
###### Les données en sortie seront au format CSV (*.csv) :
```
CSV = COLONNES CRLF *(LIGNE)
COLONNES = ‘NOM,PRENOM,ORGANISATION,FONCTION,TELEPHONE,MOBILE,COURRIEL’
LIGNE = TEXT.’,’.TEXT.’,’.TEXTORGA_FONC.’,’.TEXTORGA_FONC.’,’.TEXTTEL.’,’.TEXTTEL.’,’.TEXT
TEXT = 1*(WSP/VCHAR)
TEXTORGA_FONC = TEXT *(‘/’ TEXT)
TEXTTEL = 1*(‘+’.11DIGIT)
```
##### Exportation
Les fichiers exportés seront sauvegardés dans un dossier *exports* qui sera créé s'il n'existe pas.
Leur nom sera sous la forme suivante : `merge-contacts__
*NB:* Pour lire correctement un fichier CSV sur un logiciel de type tableur, il faudra l'importer depuis ce dernier et définir le délimiteur en tant que virgule.
### Mode d’Emploi
Lancez l'application en éxecutant le fichier main.js qui se trouve dans le répertoire du projet avec Node.js avec la commande suivante :
```bash
$ node main.js
```
L'application Node.js se lancera et proposera plusieurs choix à l'utilisateur :
- **Import de fichier(s) .vcf (vCard)** : l'utilisateur pourra renseigner un ou plusieurs fichiers afin de les importer
- **Afficher les contacts importés** : l'utilisateur pourra afficher les contacts qu'il aura importé depuis un fichier .vcf
- **Rechercher les profils similaires** : l'utilisateur pourra lancer une opération pour détéerminer les profils similaires dans les contacts qu'il a importé, il pourra aussi les afficher
- **Afficher les incohérences pour des profils similaires** : l'utilisateur pourra afficher les conflits pour des mêmes profils
- **Fusionner des profils similaires** : l'utilisateur pourra fusionner des contacts dont les prénoms et noms sont similaires en choisissant les informations correctes
- **Exporter les contacts fusionnés** : l'utilisateur pourra exporter au format CSV ou vCard les profils qu'il aura préalablement fusionné
L'utilisateur pourra naviguer facilement avec les opérations **Retour** et **Quitter**.
Il peut aussi **Réinitialiser** ses importations.
### Dépendances
**nodejs** >= v5.1.0
Les modules utilisés sont les suivants :
- *async* v1.5.x
- *chalk* v1.1.x
- *cli-table* v0.3.x
- *inquirer* v0.11.x
- *json2csv* v3.0.x
L’installation des modules doit être réalisé dans le dossier du projet.
Pour installer les modules, utiliser la commande suivante :
```bash
$ npm install
```
### Fichiers joints
Des échantillons de données sont joints à cette solution logicielle. Ils permettront de tester fonctionnellement la solution proposée en fonction des données que l’utilisateur rentrera dans les différents champs.
Ces échantillons de données se trouvent dans le répertoire `./sample/` du projet. Trois fichiers sont fournis :
- *sample.vcf* : Contient **22 profils** avec **8 doublons**
- *sample_1.vcf* : Contient **5 profils** avec **2 doublons**
- *sample_s.vcf* : Liste de **5 profils similaires** (mêmes noms et prénoms)
### Liste des contributeurs
**Professeurs**
- Matthieu Tixier
- Jean-Pierre Cahier
**Équipe Atlantis**
- Yassine DOGHRI
- Valentin HACHET
- Youssef Nassim AZIZ
- Ayoub BAKKALI EL KASMI
***
Copyright © Atlantis 2015-2016 | ClearWater-Dionysos v1.1.1