README

*** Keys ***

You will need to the following twitter keys to your environment:
ENV['TWITTER_CONSUMER_KEY']
ENV['TWITTER_CONSUMER_SECRET']
ENV['OAUTH_TOKEN']
ENV['OAUTH_TOKEN_SECRET']

You will need to set an application password for admin functions (to set players and flush database)
ENV['APP_PASSWORD']

If you use Foreman (see below), you can simply add them to the .env file in root dir. Format as follows:
TWITTER_CONSUMER_SECRET=1234567890
OAUTH_TOKEN_SECRET=1234567890
OAUTH_TOKEN=14060355-1234567890
TWITTER_CONSUMER_KEY=1234567890
APP_PASSWORD=1234567890

*** Start Processes ***

With Foreman
$ bundle exec foreman start
default port is 5000

Only webserver, with shotgun:
$ bundle exec shotgun web.rb

Only twitter filter:
$ bundle exec ruby twitter_filter.rb

All need a redis server running, eg.
$ redis-server /Volumes/data/dev/redis/redis.conf

See example config file here: https://github.com/antirez/redis/blob/557a74e56308325874c573e6dd2c6b228136de86/redis.conf


*** Pages ***

/
Main game

/admin
To set players
To see functional tweet formats (needs password)

/players
See IDs of current players

/power
See see public tweets

/show-errors
See twitter-filter status messages

/delete-errors
Clear twitter-filter status messages

/flush
Flush redis db (needs password)