README.md

MPL Backend

Explore other MPL repositories

Report Bug · Request Feature

Table of Contents

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

About The Project

This is the backend API for the Math Premier League (MPL), SIAM-VIT's Flagship Event in VIT's fest, GraVITas. This API is used to manage the check of the answer entered by the user in the clues. The API is built using Go Lang Fiber.

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/MPL-be.git
   

2. Change into the project directory

   cd MPL-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
   

5. Start the application

   go run cmd/main.go

Contributors

Akshat Gupta

License

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

Made with ❤️ by SIAM-VIT