Skip to content

5ika/tipigee

Repository files navigation

Tipigee

FOSSA Status

Tipigee est un chatbot pour les Transports Publics Genevois utilisable par Facebook Messenger et Telegram.

Le 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.

Tipigee est basé sur le framework de chatbot Messenja.

Getting Started

Ces instructions permettent d'installer un environnement de développement pour Tipigee.

Prérequis

  • Un serveur avec une URL en https, accessible depuis Internet. Pour un développement local, vous pouvez utiliser https://ngrok.com/
  • Un token d'accès à l'API pour chaque service que vous voulez utiliser (plus de détails sur la page de Messenja)
  • Un token d'accès à l'API des TPG. Voir la page des TPG sur l'Open-data
  • Un compte gratuit sur Dialogflow qui permet de faire du NLP
  • NodeJS >= 7.0
  • Un serveur Redis

Installation

Récupérer les sources de Tipigee et installer les dépendances

git clone https://github.com/5ika/tipigee
cd tipigee
npm install

Configurer Dialogflow

Sur 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.

Configurer les accès aux différentes API

cp config.example.json config.json
nano config.json # Ajouter les tokens ainsi que l'URL du serveur

Mettre à jour les noms des arrêts

Voir cette page.

Lancement du serveur Redis

Si vous utilisez Docker, vous pouver facilement lancer un serveur Redis localement :

docker run -d --restart always -v $PWD/data:/data --name redis-tipigee -p 6379:6379 redis:alpine

Lancement du serveur

node index
# OU
npm install -g nodemon
nodemon index # Le serveur est mis à jour à chaque modification

Contributions

Ce projet est encore jeune et n'a pas encore de règles propres à respecter pour son développement.

N'importe qui est libre de faire des modifications et proposer des améliorations sous forme de Pull Request dans ce dépôt.

Si vous souhaitez aider mais que vous ne savez pas par où commencer, regarder les propositions d'améliorations dans les Issues.

Auteurs

Licence

Ce projet est placé sous licence GPLv3.

FOSSA Status

About

Chatbot pour les Transports Publics Genevois

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published