aicon: AI Contest Platform

A platform that enables lecturers to create an environment where students can run and evaluate their artificial intelligence agents.

Requirements

• Python >= 3.12
• Django
• Celery
• Additional requirements listed in requirements.txt

Database

aicon requires a database server. We recommend using MySQL for this purpose. To run MySQL in a Docker container, use the following command:

docker run --name aicon-mysql -e MYSQL_ROOT_PASSWORD=<your_password> -e MYSQL_DATABASE=aicon -p 3306:3306 -d mysql

Be sure to replace <your_password> with a strong, secure password of your choice.

If you prefer to use SQLite instead of MySQL, no additional setup is required.

Message Broker

aicon relies on Celery, which requires a message broker. We recommend using RabbitMQ for this purpose.

To run RabbitMQ using Docker, you can use the following command:

docker run -d --hostname aicon-rabbit --name aicon-rabbit \
  -e RABBITMQ_DEFAULT_USER=<your_username> \
  -e RABBITMQ_DEFAULT_PASS=<your_password> \
  -p 15672:15672 \
  -p 5672:5672 \
  rabbitmq:3-management

Make sure to replace <your_username> and <your_password> with secure credentials of your choice.

Setup

1. Install the requirements

   pip install -r requirements.txt

2. Duplicate the example.env file to create a new .env file.
3. Update the values in the .env file according to server configuration.
4. Create a secret key and store it in .env as SECRET_KEY=<Your Key>.
5. Migrate, load data, and create the superuser.

   python manage.py makemigrations
   python manage.py migrate
   python manage.py loaddata groups partitions
   python manage.py createsuperuser

6. Run server.

   python manage.py runserver

7. For deployment, make sure to set DEBUG=False and use a robust WSGI server like Gunicorn.

   python manage.py collectstatic
   gunicorn --bind 0.0.0.0:8000 aicon.wsgi

API

/api/v1/