Herring is a web application for a puzzlehunt team's progress tracking and task management. It uses Django (with Python 3!) and ReactJS. It is inspired by the older puzzlehunt management tool tsar.
Members of teams Metropolitan Rage Warehouse and Death and Mayhem have contributed to Herring development!
brew install python3 postgres npm
Install Redis, which is apt-get install redis-server or brew install redis for all I know.
Install node/JS dependencies:
cd herring/puzzles/static-src && npm install && cd ../../../
Make sure you have virtualenv installed. Then:
virtualenv --python $(which python3) henv
source henv/bin/activate
You'll see (henv) in front of your command line after doing this. If you open more terminals, you'll have to do the above step again for them.
Install Django and other Pythonic dependencies:
pip3 install -r requirements.txt
Set up your database:
ln -sfv /usr/local/opt/postgresql/*.plist ~/Library/LaunchAgents
launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
(On Ubuntu: it's already running after installation.)
(On Ubuntu before doing the next step: sudo -u postgres createuser [your current username, under which you will be running herring])
createdb herringdb
When running as Metropolitan Rage Warehouse, get the Python module of stuff we can't commit to GitHub by downloading it from the pinned entry in https://ireproof.slack.com/messages/tech/. Save it as herring/herring/secrets.py (that is, in the same directory that settings.py is in).
Run:
cd herring && python3 manage.py migrate
(OR, instead of createdb and migrate, you can restore from a prod backup. This is messy. If your prodbackup is named asdf.dump, do the following (NOTE: this is dangerous if your dump does not contain a specified database name, as it will overwrite the 'postgres' database!)
sudo -u postgres pg_restore --no-owner --role=postgres -d postgres -Cc asdf.dump
sudo -u postgres psql -d postgres -c 'ALTER DATABASE whateverprodcalledit RENAME TO herringdb'
sudo -u postgres psql -d postgres -c 'ALTER USER myusername WITH SUPERUSER'
Uh, obviously that last line should not be required. ?!
python3 manage.py runserver
And in a second shell:
cd herring/puzzles/static-src
./node_modules/.bin/webpack --watch
You can then view the website at localhost:8000.
Create a superuser so you can log into localhost:8000/admin/ and make rounds and puzzles:
python3 manage.py createsuperuser
To use the Slack and Google Drive integrations, you need to be running a worker process, so run this in yet another shell:
python3 manage.py celery worker
This software is licensed under the MIT License (Expat).