https://github.com/unicodeveloper/typingspeed-bot

:speech_balloon::computer: A bot for you & your team to measure your typing speed on Slack
https://github.com/unicodeveloper/typingspeed-bot

Last synced: 3 months ago
JSON representation

:speech_balloon::computer: A bot for you & your team to measure your typing speed on Slack

• Host: GitHub
• URL: https://github.com/unicodeveloper/typingspeed-bot
• Owner: unicodeveloper
• Created: 2015-04-27T18:17:03.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-12-25T13:50:54.000Z (about 10 years ago)
• Last Synced: 2024-12-16T23:49:37.796Z (about 1 year ago)
• Language: CoffeeScript
• Homepage:
• Size: 31.3 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

# Typingspeed-bot

[![NPM version](https://img.shields.io/npm/v/typingspeed-bot.svg?style=flat)](https://www.npmjs.com/package/typingspeed-bot)

![](https://img.shields.io/badge/unicodeveloper-approved-brightgreen.svg)

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](#configuration)

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][redistogo] 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.

[redistogo]: https://redistogo.com/

## Deployment

    % heroku create 

    % git push heroku master

Check out this [tutorial](http://goodheads.io/2015/10/30/creating-your-first-slack-bot/#time-to-deploy) 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][heroku-node-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][deploy-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][deploy-unix] and [deploying

hubot onto Windows][deploy-windows] wiki pages.

[heroku-node-docs]: http://devcenter.heroku.com/articles/node-js

[deploy-heroku]: https://github.com/github/hubot/blob/master/docs/deploying/heroku.md

[deploy-unix]: https://github.com/github/hubot/blob/master/docs/deploying/unix.md

[deploy-windows]: https://github.com/github/hubot/blob/master/docs/deploying/unix.md

## Restart the bot

You may want to get comfortable with `heroku logs` and `heroku restart` if

you're having issues.