https://github.com/goronfreeman/slack-bedtimebot
Slack bot that provides a gentle reminder that it's time for bed.
https://github.com/goronfreeman/slack-bedtimebot
Last synced: about 2 months ago
JSON representation
Slack bot that provides a gentle reminder that it's time for bed.
- Host: GitHub
- URL: https://github.com/goronfreeman/slack-bedtimebot
- Owner: goronfreeman
- Created: 2016-11-27T02:20:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-29T04:54:47.000Z (over 9 years ago)
- Last Synced: 2025-01-20T17:32:01.335Z (over 1 year ago)
- Language: CoffeeScript
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bedtimebot
Bedtimebot provides a gentle bedtime reminder to your Slack team members.
But watch out! It has a bit of a temper when you don't heed its suggestions.
Bedtimebot is a chat bot built on the [Hubot][hubot] framework. It was
initially generated by [generator-hubot][generator-hubot], and configured to be
deployed on [Heroku][heroku] to get you up and running as quick as possible.
[heroku]: http://www.heroku.com
[hubot]: http://hubot.github.com
[generator-hubot]: https://github.com/github/generator-hubot
### Running Bedtimebot Locally
You can start Bedtimebot locally by running:
% HUBOT_SLACK_TOKEN= ./bin/hubot --adapter slack
You will first have to [create a new bot user](#slack-environment-variables) to
get your API token.
Then you can interact with Bedtimebot by sending it a DM in Slack.
### Configuration
Follow the steps outlined in the [Slack Environment Variables](#slack-environment-variables)
section, then invite Bedtimebot to the Slack channels you would like it to
participate in.
## Deployment
% heroku create
% git push heroku master
If you run into any problems, checkout Heroku's [docs][heroku-node-docs].
More detailed documentation can be found on the [deploying hubot onto
Heroku][deploy-heroku] wiki page.
[heroku-node-docs]: http://devcenter.heroku.com/articles/node-js
[deploy-heroku]: https://github.com/github/hubot/blob/master/docs/deploying/heroku.md
## Slack Environment Variables
To get up and running, you will need to set some environment variables.
First, [create a new bot user][new-bot-user] from your Slack team's settings
page and copy the API token.
% heroku config:add HUBOT_SLACK_TOKEN="..."
Next, find your Heroku app's URL. This is the endpoint that Bedtimebot will
ping every 20 minutes to prevent Heroku from putting your bot to sleep while
using Heroku's free tier.
% heroku config:add APP_URL="..."
[new-bot-user]: https://my.slack.com/services/new/bot
## Restart the bot
You may want to get comfortable with `heroku logs` and `heroku restart` if
you're having issues.