Skip to content

Latest commit

 

History

History
179 lines (154 loc) · 7.15 KB

README.md

File metadata and controls

179 lines (154 loc) · 7.15 KB

Codechef-VIT


Devsoc Backend '24

The official Backend API for DEVSOC'24 Hackathon Portal

Tech Stack

  • Golang: An open-source programming language supported by Google

    • Echo: A fast http router based on the go standard HTTP.
    • pgx: A postgresql driver for go.
    • gomail: A library to send emails using go.
    • go-redis: Go redis client.
  • Docker: Docker is a platform for developing, shipping, and running applications using containers.

  • PostgreSQL: The worlds most advanced Open Source Relational Database.

  • Redis: The world’s fastest in-memory database from the ones who built it.

Features

  • User Authentication
  • Teams
  • Project management
  • Admin routes where Admins can directly score teams

How To Run

Prerequisites:

  • Docker: Docker is a platform for developing, shipping, and running applications using containers.
  • Postman/Apidog: A tool to test backend APIs without having to write frontends.
  • goose: Goose is a database migration tool. Manage your database schema by creating incremental SQL changes or Go functions.

Steps

  1. Clone the Repository: git clone https://github.com/CodeChefVIT/devsoc-backend-24
  2. Start the containers: cd devsoc-backend-24 && cp .env.example .env && make build. Please ensure that you put the correct SMTP credentials to get email services
  3. Run the migrations: make migrate-up
  4. Use postman and test the api at the endpoint http://localhost/api

Authors

Vedant

Vedant Matanhelia

GitHub LinkedIn

Aman

Aman L

GitHub LinkedIn

Prateek

Prateek Srivastava

GitHub LinkedIn

Akshat

Akshat Gupta

GitHub LinkedIn

Shivam

Shivam Sharma

GitHub LinkedIn

Aaditya

Aaditya Mahanta

GitHub LinkedIn

Shivam

Shivam Gutgutia

GitHub LinkedIn

License

Copyright © 2024, CodeChef-VIT and all other contributors. Released under the MIT License.

Made with ❤️ by CodeChef-VIT