1# Tipigee
 2
 3Tipigee est un chatbot pour les [Transports Publics Genevois](https://tpg.ch/) utilisable par Facebook Messenger et Telegram.
 4
 5- [Facebook Messenger](https://www.messenger.com/t/tipigee)
 6- [Telegram](https://telegram.me/tipigeebot)
 7
 8Le 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.
 9
10Tipigee est basé sur le framework de chatbot [Messenja](https://github.com/5ika/messenja).
11
12## Getting Started
13
14Ces instructions permettent d'installer un environnement de développement pour Tipigee.
15
16### Prérequis
17
18- Un serveur avec une URL en https, accessible depuis Internet. Pour un développement local, vous pouvez utiliser https://ngrok.com/
19- 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))
20- 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
21- Un compte gratuit sur [Dialogflow](https://dialogflow.com/) qui permet de faire du NLP
22- NodeJS >= 7.0
23- Un serveur Redis
24
25### Installation
26
27#### Récupérer les sources de Tipigee et installer les dépendances
28
29```bash
30git clone https://github.com/5ika/tipigee
31cd tipigee
32npm install
33```
34
35#### Configurer Dialogflow
36
37Sur 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.
38
39#### Configurer les accès aux différentes API
40
41```bash
42cp config.example.json config.json
43nano config.json # Ajouter les tokens ainsi que l'URL du serveur
44```
45
46#### Mettre à jour les noms des arrêts
47
48Voir [cette page](https://github.com/5ika/tipigee/blob/master/init/README.md).
49
50#### Lancement du serveur Redis
51
52Si vous utilisez Docker, vous pouver facilement lancer un serveur Redis localement :
53
54```bash
55docker run -d --restart always -v $PWD/data:/data --name redis-tipigee -p 6379:6379 redis:alpine
56```
57
58#### Lancement du serveur
59
60```bash
61node index
62# OU
63npm install -g nodemon
64nodemon index # Le serveur est mis à jour à chaque modification
65```
66
67## Contributions
68
69Ce projet est encore jeune et n'a pas encore de règles propres à respecter pour son développement.
70
71N'importe qui est libre de faire des modifications et proposer des améliorations sous forme de Pull Request dans ce dépôt.
72
73**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).
74
75## Auteurs
76
77- [Tim Izzo](https://github.com/5ika)
78
79## Licence
80
81Ce projet est placé sous licence [GPLv3](https://github.com/5ika/tipigee/blob/master/LICENSE).