Git Product home page Git Product logo

fomobot's Introduction

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.

fomobot's People

Contributors

gabebw avatar gfontenot avatar tonyd256 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.