Setup Instructions

1. First, install the pipenv package, by using this command in the terminal:

pip install pipenv

2. Then, we use pipenv to read the contents of the Pipfile and install all the necessary packages that make the frontend work. This can be accompished with:

pipenv install

(Make sure the terminal is opened within the correct folder!)

3. Initialize the database:

pipenv run python progcomp/scripts/initialize_db.py

4. Run the server with:

pipenv run flask --app progcomp --debug run

The site will then be running locally at localhost:5000, and you can access it as a url in your preferred web browser.

You can stop it at any time by pressing CTRL+C in the terminal.

Admin Operation

Once the server is running, you control it by using the admin panel, found at localhost:5000/admin. The password used is set using environment variables.

Read .env.example for an example for an .env file.

Create a .env file:

• SECRET_KEY can be anything; just used to sign the Flask stuff
• ADMIN_KEY_HASH should be the hashed version of the password you've chosen

To get the hashed version of your password:

1. Load the venv with pipenv shell
2. Run python to access the python interactive environment
3. Run import werkzeug
4. Run print(werkzeug.security.generate_password_hash("your_password"))
5. Copy the output to ADMIN_KEY_HASH

Custom behaviour

• SQL-Alchemy makes editing the data while live very easy, write your queries following the template and you can do a lot
• Alembic is used for DB versioning, if you want to add or remove fields (don't remove while live)