diff --git a/README.md b/README.md index 6f9b852f1165a7224bebaeef119b632ceff41090..52528f212f2bd6253eacd7374e309b077e23c351 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ -# wa-poll +# pirati.cz program point popularity measurer -A polling program made for my web app class, in the span of about 3 hours. It's not great, but works well enough. +A quick backend server to sort the 2022 communal election points' popularity on pirati.cz, not yet integrated into the newer website system. + +## Setup + +- Copy `config.example.json` to `config.json`. +- Change the `SECRET_KEY` and `IDENTIFIER_HASH_PEPPER` to random values with very high entropy. +- Set the `DATABASE_URL` environment variable to something like `postgresql://username:password@hostname/dbname`. +- Run the app with your WSGI server of choice that integrates the `create_app()` function. Personally, I like gunicorn. (`gunicorn "measurer:create_app()"`)