typingspeed-bot v1.0.0

Typingspeed-bot

Typingspeed-bot is a bot built on the Hubot framework.

Running Typingspeed-bot Locally

You can test your hubot by running the following, however some plugins will not behave as expected unless the environment variables they rely upon have been set.

You can start Typingspeed-bot locally by running:

% bin/hubot

You'll see some start up output and a prompt:

[Fri Dec 25 2015 14:10:35 GMT+0100 (GMT)] INFO Using default redis on localhost:6379
typingspeed-bot>

Then you can interact with Typingspeed-bot by typing typingspeed-bot help.

typingspeed-bot> typingspeed-bot help
`typingspeed-bot` - Welcomes you to typingspeed-bot with some instructions
`ready` - Displays a random paragraph that you are required to type
...

Persistence

If you are going to use the hubot-redis-brain package (strongly suggested), you will need to add the Redis to Go addon on Heroku which requires a verified account or you can create an account at Redis to Go and manually set the REDISTOGO_URL variable.

% heroku config:add REDISTOGO_URL="..."

If you don't need any persistence feel free to remove the hubot-redis-brain from external-scripts.json and you don't need to worry about redis at all.

Deployment

% heroku create <app-name>
% git push heroku master

Check out this tutorial to learn how to deploy a slackbot on heroku

If your Heroku account has been verified you can run the following to enable and add the Redis to Go addon to your app.

% heroku addons:add redistogo:nano

If you run into any problems, checkout Heroku's docs.

You'll need to edit the Procfile to set the name of your hubot.

More detailed documentation can be found on the deploying hubot onto Heroku wiki page.

Deploying to UNIX or Windows

If you would like to deploy to either a UNIX operating system or Windows. Please check out the deploying hubot onto UNIX and deploying hubot onto Windows wiki pages.

Restart the bot

You may want to get comfortable with heroku logs and heroku restart if you're having issues.