• yarn
• virtualenv
• sqlite3

Initialize VirtualEnv

virtualenv -p python3.6 venv

Activate it (must be done in every new shell in the working directory) and install the python dependencies

source venv/bin/activate
pip3 install -r requirements.txt

Install npm dependencies

yarn install
cd client/ && yarn install

Create/Recreate database (also on changes to server/database/schema.sql)

yarn db-rewrite

Run the flask setup

pip3 install -e .

Start Vue Development Server and Flask Backend

yarn dev
// navigate to localhost:3000 for FrontEnd
// navigate to localhost:5000 for BackEnd

If you want to only serve the Frontend (not recommended)

cd client/ && yarn dev

We are applying the 12-factor principles to protect our application secrets. Therefore, the app settings are managed using dotenv. For the BackEnd to work, save the following values in your root .env file:

GITHUB_CLIENT_ID=...
GITHUB_CLIENT_SECRET=...
SECRET_KEY=...

Replace the dots with your own variables. For the Github Client ID and Secret, register contest.io as a new Github OAuth application here. You may name it something like 'contest.io-dev-YOUR_USERNAME'. Set the authorization callback url to http:https://localhost:5000/api/github-callback

The SECRET_KEY variable can be set to whatever you want.

For the returned objects, see the database schema