rnhmjoj
/
asjon
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
our local chat bot
256 Commits
2 Branches
25 Tags
695 KiB
CoffeeScript 98.9%
Nix 0.8%
Shell 0.3%
 
 
 
Go to file
Michele Guerini Rocco f319252ae8
fix weather tests 		2018-09-15 13:29:13 +02:00
bin remove quotes 2017-02-27 00:28:36 +01:00
scripts fix weather tests 2018-09-15 13:29:13 +02:00
test fix weather tests 2018-09-15 13:29:13 +02:00
.editorconfig asjon is born 2015-04-23 14:17:30 +02:00
.gitignore update gitignore 2018-09-15 13:20:54 +02:00
README.md switch to yarn 2018-06-20 20:12:48 +02:00
external-scripts.json Remove deprecated modules 2015-09-28 21:11:00 +00:00
package.json add html report for integrity tests 2018-06-21 03:30:24 +02:00
shell.nix switch to yarn 2018-06-20 20:12:48 +02:00
yarn.lock update yarn lock 2018-09-15 13:21:07 +02:00

README.md

Asjon ROBOT

Asjon è un chat bot creato usando l'Hubot framework.

Asjon può:

  • cercare immagini e gif su internet
  • cercare video di youtube
  • riportare il meteo
  • ricordare nozioni o date
  • creare memes
  • fare calcoli e risolvere problemi con wolfram|alpha
  • inviare immagini di RMS
  • invitare persone in una stanza
  • dare informazioni sui propri contatti
  • aprire reverse shell
  • aggiornarsi ed eseguire test autonomamente
  • e altro ancora

Asjon è sviluppato in collaborazione con gli studenti della 5IA (2014/2015) dell'IIS Galileo Galilei di Crema.

Usare Asjon

Asjon è sempre online su matrix con l'username @asjon:maxwell.ydns.eu

Sviluppare Asjon

Puoi testare asjon seguendo queste istruzioni, però alcuni componenti necessitano di variabili d'ambiente particolari per essere configurati correttamente (ad esempio i dati di accesso al registro elettronico per l'agenda)

Dipendenze

Asjon necessita di:

  • node e yarn
  • redis se si vuole salvare la sua memoria in maniera persistente
  • graphicsmagick per la compressione delle immagini

Installazione

Si consiglia di usare di usare nix per gestire le dipendenze. È presente un'espressione nix.shell nella root del progretto che può essere usata semplicemente eseguendo

$ nix-shell

nella directory. Nella nuova shell installare asjon con

$ yarn install

Utilizzo

Puoi avviare asjon tramite nix-shell con

$ nix-shell --argstr mode run

Altre mode possibili sono:

  • run: avvia asjon sull'adapter di maxwell (è necessario impostare user/pass con le rispettie variabili)
  • test: esegui i test d'integrità
  • shell (default): apre una nix-shell

Puoi anche avviare asjon manualmente eseguendo

$ bin/hubot

Se tutto va bene dovrebbe comparire una cosa del genere:

[Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
asjon>

Puoi interagire con asjon scrivendo asjon help o qualsiasi altro suo comando.

Test

Asjon dispone di alcuni test d'integrità nella cartella test/.

Per eseguirli, occorre:

  1. installare mocha tramite yarn global add mocha
  2. lanciare i test tramite yarn test dalla cartella della repo
  3. opzionalmente è possibile generare i report di copertura dei test usando yarn coverage.

Nota Bene: è opportuno eseguire sempre i test d'integrità prima di contribuire una modifica. Ancora meglio sarebbe allegare dei test di integrità insieme alle nuove funzioni aggiunte

Scripting

Gli script di Asjon sono nella cartella scripts. La Scripting Guide di hubot è molto utile per imparare come funzionano

Hosting

Asjon può essere hostato come un qualsiasi Hubot.

Il ramo master di Asjon è sempre hostato online ed è accessibile tramite matrix all'username @asjon:maxwell.ydns.eu.

Licenza

Hubot e Asjon sono distribuiti sotto la MIT License