IEEE-VIT/enigma7-backend

About

Enigma is an online cryptic hunt organized by the IEEE-VIT Student Chapter anually. Enigma 7.0 was live from 4th December 4:20 PM (IST) to 6th December 4:20 PM (IST). Like all of it's previous editions, it remained undefeated with nobody being able to solve all the challenges.

This repository contians the codebase for the backend used for Enigma 7.0.

Architecture

Tools and Technologies

Django
PostgreSQL
Redis
Celery
HAProxy
Docker/docker-compose
GCP

Getting Started

Please refer to the above list of tools and make sure you're familiar with the ones that concern you before you actually start working.

To get started:

Clone the repo. git clone https://github.com/ieee-vit/enigma7-backend
Install the dependencies (inside a virtual environment preferably). pip install -r requirements.txt
Create a PostgreSQL database. createdb enigma7
Create a .env at the root of the project directory and populate it by referring to the .env.template.

Running a dev server

Generate migrations and apply them. python manage.py makemigrations python manage.py migrate
Run the server. python manage.py runserver

Running the Celery workers

We need a message queue for Celery. We went ahead with Redis, but we can also use RabbitMQ. To run Redis, first install it and run redis-server
Run the main Celery worker. celery -A enigma7_backend worker --loglevel=DEBUG
Run the Celery Beat worker for executing periodic tasks: celery -A enigma7_backend beat -l DEBUG --scheduler django_celery_beat.schedulers:DatabaseScheduler

Using Docker

We include a Dockerfile.dev and docker-compose.dev.yml to spin up a dev server quickly. From the root of the project, run:

docker-compose up -f docker-compose.dev.yml

Note: Please make sure that your .env with all the correct values is present in the codebase inside the container filesystem. You can also use the --env-file flag as well.

Contributing

To start contributing, check out CONTRIBUTING.md . New contributors are always welcome to support this project. If you want something gentle to start with, check out issues labelled as easy or good-first-issue.