Colosseum Website

The website for Colosseum, the automated AI Tournament engine. This project contains the user facing website, a public API as well as the internal API used by the tournament engine.

Local setup

• Get the source code from github

• Install pyenv:

  • The recommended way is listed here: https://github.com/pyenv/pyenv#basic-github-checkout
  • If you know what you are doing feel free to use another way

• Install the current python version. Note that this command should be run from inside the git repository.

pyenv install `cat .python-version`

• Ensure that pip is available:

python -m ensurepip

• Install poetry

python -m pip install poetry

• Install the package dependencies

poetry install

• Rehash python commands

pyenv rehash

• Install the git hooks

pre-commit install -t pre-commit -t pre-push

• Install redis and postgres

• Setup postgres to connect with django. The easiest way to do this is to create a database named postgres, with a user named postgres, with postgres as the password. This is only safe for the local environment where no remote connections to the databased are allowed (this is the default behavior).

  • Open psql as the postgres user using sudo -u postgres psql
  • Create the database using CREATE DATABASE postgres;
  • Create the user using CREATE USER postgres WITH ENCRYPTED PASSWORD 'mypass';
  • Grant access to the new user to the newly created table GRANT ALL PRIVILEGES ON DATABASE postgres TO postgres;

• Run the migrations

poetry run python manage.py migrate

• Create a superuser. Provide a password when asked. If the password is too simple, a warning will be shown, but the validating can be bypassed. Since this is only for local environment, it is safe to do so.

poetry run python manage.py createsuperuser --username=admin --email=admin@admin.com

• Create an auth token for the superuser. Save this token. It will be used to connect to other parts of the system.

poetry run python manage.py drf_create_token admin

• Start the server

poetry run python manage.py runserver

• Start celery. Some functionality of the site depents on the celery workers being running.

poetry run celery --app app worker --loglevel=INFO --beat

• TODO: Setup minio

• Setup the colosseum tournament engine. Follow the instructions from https://github.com/h3nnn4n/colosseum

Troubleshooting

• psycopg2 fails to install

  • Try installing postgres

• Django fails to run and complains about missing libmagic

  • Install libmagic. If you are on macos using homebrew, you might need to symlink it to /usr/local/lib

• Running fails with ModuleNotFoundError: No module named '_lzma'

  • If you are using pyenv, you need to install xz and then rebuild python

LICENSE

Released under the MIT license. See LICENSE for more details.