thoughtbot / FOMObot

A slack bot to help with FOMO.
MIT License
62 stars 14 forks source link

FOMObot

A Slack bot that monitors channels for message activity spikes. When activity spikes within a channel, FOMObot posts a message to the #fomo channel to let anyone in that channel know that they could be missing out on an important conversation.

Development Environment Setup

This project uses Stack to build and run locally. You can install Stack via the instructions on their site.

Then run:

bin/setup

FOMObot needs a Slack API token. You can create a new Slack bot and generate an API token here.

Insert the Slack API token into the .env file.

SLACK_API_TOKEN=your_token_goes_here
...

Running Locally

Run this:

bin/run

Deployment Environment Setup

This project uses Docker to build for deployment. You can install docker and docker-compose via the instructions on their website.

If you're using OS X, you will also need docker-machine. Make sure to [setup Docker Machine] properly if it's your first time using it.

FOMObot can be easily deployed to Heroku. If you would also like to deploy to Heroku then start by creating a Heroku account if you don't already have one. Next, install the Heroku Toolbelt.

Log in to Heroku by running heroku login.

Create a new app for this project by running heroku apps:create YOUR_APP_NAME.

Set the same environment variables in your Heroku app as you have in .env.

Finally, install the heroku-docker plugin.

heroku plugins:install heroku-docker

Deploying to Heroku

Simply run heroku docker:release.

Contributing

See the CONTRIBUTING document. Thank you, contributors!

License

FOMObot is Copyright (c) 2016 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

thoughtbot

FOMObot is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects or look at our product case studies and hire us to help build your Haskell app.