Giter Club home page Giter Club logo

coffeemate's Introduction

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.

coffeemate's People

Contributors

anthonygarvan avatar dschaller avatar

Watchers

 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.