README.md

Mario Kart 8 Championship Website

This repository contains the website to run a Mario Kart 8 tournament.

Quick Start

Development

Since the website is built with an old version of python, it requires that you have conda installed.

conda env create -p ./venv --file environment.yml
conda activate ./venv
python manage.py migrate
python manage.py runserver 5000

Deployment

# Build the container with all its dependencies
docker build -t mk8 .
# Test that the container works as intended
docker run -p 5000:5000 --rm mk8
# Check on http://localhost:5000/ that the site works correctly
# Be aware that in this way the data is saved only inside the container

Environment Variables to Set

• DJANGO_SECRET_KEY: long random string which has to remain secret, since it is used for security of django deployment.
• ADMIN_EMAIL and ADMIN_PASSWORD to set up when ./start.sh is first called to automatically create an admin superuser if it doesn't exist.

TODO

1. Document how to set up Google OAuth