coding-relay-be

Table of Contents

• About The Project
• Built With
• Getting Started
• Prerequisites
• Installation
• Contributors
• License

About The Project

This is the backend API for the Coding Relay, SIAM-VIT's Flagship Event in VIT's fest, Yantra. The API is responsible for handling user authentication, team registration, and leaderboard updation. The API is built using Go and PostgreSQL, and Redis is used for caching.

Key Features:

• Real time leaderboard monitoring
• Team score updation

Built With

This project is built using the following technologies and frameworks:

• Go
• PostgreSQL
• Redis

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have the following installed:

• Go
• PostgreSQL 13 or higher
• Docker (optional but recommended)

Installation

1. Clone the repo

   git clone https://github.com/SIAM-VIT/coding-relay-be.git
   
   

2. Change into the project directory

   cd coding-relay-be
   
   

3. Install dependencies

   go mod download
   
   

4. Set up PostgreSQL and configure .env with your database credentials:

    # Postgres Configuration
    DB_HOST=abc
    DB_PORT=abc
    DB_USER=abc
    DB_PASSWORD=abc
    DB_NAME=abc
   
    # Redis Configuration
    REDIS_HOST=abc
    REDIS_PORT=abc
    REDIS_PASSWORD=abc
    REDIS_DB=abc
   
    REDIS_URI=abc
   
    JWT_SECRET_KEY=abc
   
   

5. Start the application

   go run cmd/main.go
   

Contributors

License

Distributed under the MIT License. See LICENSE for more information.

Made with :heart: by SIAM-VIT