devsoc-be-24

command module
v0.0.0-...-23e8201 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 11, 2025 License: MIT Imports: 0 Imported by: 0

README

Codechef-VIT

Devsoc Backend '25

The official Backend API for DEVSOC'25 Hackathon Portal

Features

  • Fully-featured REST API built with Go
  • Postgres integration using SQLC for typesafe bindings
  • Structured routing and controllers
  • JWT authentication and middleware
  • Comprehensive logging and error handling
  • Docker and docker-compose configuration for containerized deployment
  • API documentation generation via scalar

Tech Stack

  • Go
    • Echo: Minimalist Go web framework
    • SQLC: Type-safe Go from SQL
    • pgx: PostgreSQL driver for Go
    • gomail: Send emails in Go
    • go-redis: Redis client for Go
  • PostgreSQL: Open-source relational database
  • Docker: Container platform
  • Redis: In-memory data store
  • Goose: DB migration tool for Go

How To Run

Clone the repo
$ git clone https://github.com/CodeChefVIT/devsoc-be-25
$ cd devsoc-be-25
Download Dependencies
$ go mod download
Fill Environment Variables
$ cp .env.sample .env
Start Containers
$ docker compose up --build
Apply Migrations
$ make up

Contributors

profilepic

Vedant Matanhelia

GitHub LinkedIn

profilepic

Soham Mahapatra

GitHub LinkedIn

profilepic

Aman L

GitHub LinkedIn

profilepic

Vaibhav Sijaria

GitHub LinkedIn

profilepic

Jothish Kamal

GitHub LinkedIn

profilepic

Aman Singh

GitHub LinkedIn

profilepic

Abhinav Anand

GitHub LinkedIn

profilepic

Abhinav Ganeshan

GitHub LinkedIn

profilepic

Abhinav Garg

GitHub LinkedIn

profilepic

Abhinav Pant

GitHub LinkedIn

profilepic

Nishant Gupta

GitHub LinkedIn

License

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

Made with :heart: by CodeChef-VIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
api command
pkg
db
dto

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL