asjon/README.md

64 lines
1.9 KiB
Markdown
Raw Normal View History

2015-04-26 15:30:43 +02:00
# Asjon ROBOT
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Asjon è un chat bot creato usando l'[Hubot][hubot] framework.
2015-04-23 14:17:30 +02:00
[hubot]: http://hubot.github.com
2015-04-26 15:30:43 +02:00
## Usare Asjon
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Asjon è sempre online su Telegram con l'username `Asjon ROBOT`
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
## Sviluppare Asjon
Puoi testare asjon seguendo queste istruzioni, però alcuni componenti necessitano
di [variabili d'ambiente](#configuration) particolari per essere configurati
correttamente (ad esempio i dati di accesso al registro elettronico per l'agenda)
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
### Dipendenze
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Asjon necessita di:
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
- `node` e `npm`
- `redis` se si vuole salvare la sua memoria in maniera persistente
- `phantomjs` per utilizzare il modulo agenda/compiti
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
### Installazione
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
1. installare le dipendenze. Su arch linux: `pacman -S python2 nodejs phantomjs redis`
1. clonare questa repo
1. lanciare `npm install` (__Attenzione:__ usare `PYTHON=python2 npm install` su arch linux!) per installare tutte le dipendenze npm
1. se vuoi che Asjon conservi i ricordi tra una sessione e l'altra, avvia redis (su arch linux: `systemctl start redis`)
1. lanciare `bin/hubot` per testare il bot. Per usare le variabili d'ambiente usare
la sintassi di bash `VARIABILE=valore VAR2=valore2 bin/hubot`.
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
### Testing
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Puoi avviare asjon eseguendo
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
$ bin/hubot
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Se tutto va bene dovrebbe comparire una cosa del genere:
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
[Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
asjon>
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Puoi interagire con asjon scrivendo `asjon help` o qualsiasi altro suo comando.
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
### Scripting
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Gli script di Asjon sono nella cartella `scripts`.
La [Scripting Guide](scripting-docs) di hubot è molto utile per imparare come funzionano
2015-04-23 14:17:30 +02:00
[scripting-docs]: https://github.com/github/hubot/blob/master/docs/scripting.md
2015-04-26 15:30:43 +02:00
### Hosting
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Asjon può essere hostato come un qualsiasi Hubot, ma richiede phantomjs per alcune funzioni.
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Il ramo `master` di Asjon è sempre hostato online ed è accessibile tramite telegram all'username
Asjon ROBOT.
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
## Licenza
2015-04-23 14:17:30 +02:00
2015-04-26 15:30:43 +02:00
Hubot e Asjon sono distribuiti sotto la MIT License