CodeElevate Backend

This repository contains the backend for the CodeElevate project. The backend is a RESTful API that is designed to be used by the frontend of the CodeElevate project.

The API can be accessed at https://code-elevate.gopalsaraf.com/api.

Table of Contents

• API Documentation
• Deployment
• Additional Commands
• License

API Documentation

The API documentation can be found on https://code-elevate.gopalsaraf.com/docs or here.

API Routes

• /users - Routes starting with /users are used to manage users and their authentication. More Info

• /manage - Routes starting with /manage are used to manage contests and problems. More Info

• /contests - Routes starting with /contests are used to get information about contests. More Info

• /problems - Routes starting with /problems are used to get information about problems. More Info

Deployment

This backend is designed to be deployed as a Docker container. It is recommended to use the provided compose.yml file to deploy the backend.

Host System Package Dependencies

• Docker
• Docker Compose

After system dependencies are installed, clone this repository:

git clone https://github.com/Code-Elevate/Backend

Navigate to the repository

cd Backend

Rename the .env.example file to .env

mv .env.example .env

Edit the .env file

nano .env

While editing the .env file, make sure to fill in the REQUIRED fields. Without these fields, the backend will not work.

Start the backend

docker compose up -d

Additional Commands

To view logs

docker compose logs backend

To stop the backend

docker compose down

To terminate the backend

docker compose stop backend

License

This project is licensed under the MIT License - see the LICENSE file for details.