mirror of
https://github.com/danbee/scoreboard
synced 2025-03-04 08:59:11 +00:00
Add readme.
This commit is contained in:
parent
3e01606224
commit
5e78777fdb
29
README.md
Normal file
29
README.md
Normal file
@ -0,0 +1,29 @@
|
||||
Table Tennis Score Board
|
||||
=======================
|
||||
|
||||
Implements a table tennis scoreboard which can be updated by PUTing to
|
||||
particular URL's. This was part of a hack day project that involved buttons
|
||||
hooked up to an [ESP-01](http://esp8266.co.uk/shop/esp-01) module programmed to
|
||||
hit the REST end points to update the scores.
|
||||
|
||||
Games are automatically updated when a player wins (score hits at least 11 and
|
||||
is a clear 2 point lead). Players automatically switch sides between games.
|
||||
|
||||
The back end is Sinatra and the front end is powered by Riot.js. Redis is used
|
||||
for data persistence. Pusher is used for communication between the back end and
|
||||
the front.
|
||||
|
||||
Instructions
|
||||
------------
|
||||
|
||||
Install the bundle:
|
||||
|
||||
```sh
|
||||
$ bundle install
|
||||
```
|
||||
|
||||
Run the server:
|
||||
|
||||
```sh
|
||||
$ bundle exec foreman start
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user