Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wallacyyy/hubot-coffeepoll

A functional Hubot plugin to help your team to choose where to drink a coffee ! :coffee:
https://github.com/wallacyyy/hubot-coffeepoll

coffee drink foursquare fp functional functional-programming hubot poll ramda voting

Last synced: 10 days ago
JSON representation

A functional Hubot plugin to help your team to choose where to drink a coffee ! :coffee:

Awesome Lists containing this project

README

        

# Hubot-coffeepoll
[![Build Status](https://travis-ci.org/wallacyyy/hubot-coffeepoll.svg)](https://travis-ci.org/wallacyyy/hubot-coffeepoll) [![npm version](https://badge.fury.io/js/hubot-coffeepoll.svg)](http://badge.fury.io/js/hubot-coffeepoll)

Hubot-coffeepoll is a Hubot plugin that helps your team to decide where to drink a coffee.
The hubot will search for coffee shops nearby and show options to people in the chat vote.

## Configuration

### Foursquare

You need to register at [Foursquare](https://developer.foursquare.com/) and set your credentials on this environment variables:

```
FOURSQUARE_CLIENT_ID = xxx
FOURSQUARE_CLIENT_SECRET = xxx
```

### Install

Install the plugin:

```
npm install hubot-coffeepoll --save
```

And add it to your ```external-scripts.json``` file:

```
[
...
"hubot-coffeepoll"
...
]
```

## Usage

### Configuring the place for next polls
```
hubot coffeepoll near
```
Examples:
```
hubot coffeepoll near Champs-Elysées
hubot coffeepoll near my street
```
![](http://ditrospecta.com/images/2015-10-03-hubot-plugin/plugin-near-gif.gif)
```
hubot coffeepoll radius
```
Example:
```
hubot coffeepoll radius 500
```
### Starting the poll
```
hubot coffeepoll start
```
![](http://ditrospecta.com/images/2015-10-03-hubot-plugin/plugin-start-gif.gif)
### Voting
```
hubot coffeepoll vote
```
![](http://ditrospecta.com/images/2015-10-03-hubot-plugin/plugin-vote-gif.gif)
### Showing the partial results
```
hubot coffeepoll partial
```
![](http://ditrospecta.com/images/2015-10-03-hubot-plugin/plugin-partial-gif.gif)
### Finishing the poll and announcing the winner
```
hubot coffeepoll finish
```
![](http://ditrospecta.com/images/2015-10-03-hubot-plugin/plugin-finish-gif.gif)