1# Tipigee
 2[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2F5ika%2Ftipigee.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2F5ika%2Ftipigee?ref=badge_shield)
 3
 4
 5Tipigee est un chatbot pour les [Transports Publics Genevois](https://tpg.ch/) utilisable par Facebook Messenger et Telegram.
 6
 7- [Facebook Messenger](https://www.messenger.com/t/tipigee)
 8- [Telegram](https://telegram.me/tipigeebot)
 9
10Le programme de Tipigee est ouvert à la contribution. Il a été placé sous licence Open-Source dans le but d'être amélioré par le plus grand nombre.
11
12Tipigee est basé sur le framework de chatbot [Messenja](https://github.com/5ika/messenja).
13
14## Getting Started
15
16Ces instructions permettent d'installer un environnement de développement pour Tipigee.
17
18### Prérequis
19
20- Un serveur avec une URL en https, accessible depuis Internet. Pour un développement local, vous pouvez utiliser https://ngrok.com/
21- Un token d'accès à l'API pour chaque service que vous voulez utiliser (plus de détails sur la page de [Messenja](https://github.com/5ika/messenja))
22- Un token d'accès à l'API des TPG. Voir la [page des TPG](http://www.tpg.ch/web/open-data/donnees-tpg) sur l'Open-data
23- Un compte gratuit sur [Dialogflow](https://dialogflow.com/) qui permet de faire du NLP
24- NodeJS >= 7.0
25- Un serveur Redis
26
27### Installation
28
29#### Récupérer les sources de Tipigee et installer les dépendances
30
31```bash
32git clone https://github.com/5ika/tipigee
33cd tipigee
34npm install
35```
36
37#### Configurer Dialogflow
38
39Sur Dialogflow, créer un nouvel agent et importer la configuration de Tipigee dans `init/Dialogflow-Tipigee.zip` et récupérer le *Developer access token* pour la configuration.
40
41#### Configurer les accès aux différentes API
42
43```bash
44cp config.example.json config.json
45nano config.json # Ajouter les tokens ainsi que l'URL du serveur
46```
47
48#### Mettre à jour les noms des arrêts
49
50Voir [cette page](https://github.com/5ika/tipigee/blob/master/init/README.md).
51
52#### Lancement du serveur Redis
53
54Si vous utilisez Docker, vous pouver facilement lancer un serveur Redis localement :
55
56```bash
57docker run -d --restart always -v $PWD/data:/data --name redis-tipigee -p 6379:6379 redis:alpine
58```
59
60#### Lancement du serveur
61
62```bash
63node index
64# OU
65npm install -g nodemon
66nodemon index # Le serveur est mis à jour à chaque modification
67```
68
69## Contributions
70
71Ce projet est encore jeune et n'a pas encore de règles propres à respecter pour son développement.
72
73N'importe qui est libre de faire des modifications et proposer des améliorations sous forme de Pull Request dans ce dépôt.
74
75**Si vous souhaitez aider** mais que vous ne savez pas par où commencer, regarder les propositions d'améliorations dans les [Issues](https://github.com/5ika/tipigee/issues).
76
77## Auteurs
78
79- [Tim Izzo](https://github.com/5ika)
80
81## Licence
82
83Ce projet est placé sous licence [GPLv3](https://github.com/5ika/tipigee/blob/master/LICENSE).
84
85
86[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2F5ika%2Ftipigee.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2F5ika%2Ftipigee?ref=badge_large)