Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.52 KB

README.md

File metadata and controls

49 lines (31 loc) · 1.52 KB

Boston Slack Pong Bot

Build Status

Set Up Your Localhost

bundle install

Set up the database

If you haven't installed mongodb yet, run: brew install mongodb

Start mongodb mongod --config /usr/local/etc/mongod.conf

Start the server: SLACK_API_TOKEN=<your API token> foreman start

Run test

$ bundle exec rake spec                 # API test
$ cd frontend && npm test               # Frontend test

API

Slack-gamebot implements a Hypermedia API. Navigate to the application root to browse through available objects and methods. PlayPlay.io's Gamebot is here, you can see dblock's current ping-pong elo here.

A team captain must opt-in serving data via the API with set api on. The data served by the API includes team's Slack IDs, usernames and game stats.

We recommend HyperClient to query the API programmatically in Ruby.

Front End Development

$ cd frontend && npm run build

Contributing

This bot is built with slack-ruby-bot-server. See CONTRIBUTING.

Copyright and License

Copyright (c) 2015-2016, Daniel Doubrovkine, Artsy and Contributors.

This project is licensed under the MIT License.