The virtual coffee matchmaking slackbot
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
spec
.cfignore
.gitignore
.istanbul.yml
.travis.yml
CONTRIBUTING.md
LICENSE.md
README.md
app.js
bot.js
coffeemate.png
package.json

README.md

Coffeemate

The virtual coffee matchmaking slackbot

Build Status Coverage Status

Coffeemate is a slackbot which helps team members get to know each other by setting them up on virtual coffees. The usage is simple:

To sign up for a coffee session, direct message @coffeemate with:

+ coffee me!

Or, to sign up for coffee from a public channel, invite @coffeemate and then say:

+ coffee me!

It just looks for "coffee me" in a case-insensitive way in the sentence, so coffee me, Please Coffee Me, etc work as well.

If you are wondering if anyone is in line right now, you can also write

+ coffee queue

And it will respond with the number of people in line, which should always be 0 or 1, since once a pair is made the queue is emptied.

If you ran coffee me by mistake and weren't paired with anyone, you can run coffee me again and you will be paired with yourself, which empties the queue and leaves you with two cups of coffee all for yourself!

Installation

To get setup, clone the repo and run:

$ export SLACK_API_TOKEN=[your api token]
$ npm install
$ npm start

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.