README.md

CookOff 9.0 Backend

Powered By

Join Judge0 Discord

Join Sulu Discord

---

CookOff is CodeChef VIT’s flagship competitive coding event that tests the coding skills of developers. This is the backend that powers both the admin and participant portals for CookOff 9.0, serving as the backbone to manage users, questions, test cases, and submissions. Designed for efficiency and scalability, our robust backend simplifies the process of overseeing all competition-related tasks, ensuring smooth operations for both administrators and participants alike. With a focus on user-friendliness, it provides all the necessary tools to facilitate a seamless competitive experience.

---

⚙️ Tech Stack:

• Go
• Docker
• PostgreSQL
• Redis
• Atlas
• Make
• SQLC

🔧 Features

• User Management:

  • Sign Up (/user/signup)
  • Login (/user/login)

• Question Management:

  • Create Question (/question/create)
  • Get all Questions (/questions)
  • Get a Question (/question/{question_id})
  • Get Question by Round (/question/round)
  • Update Question (/question)
  • Delete Question (/question/{question_id})

• Testcase Management:

  • Create Testcase (/testcase)
  • Get Testcases by Question (/questions/{question_id}/testcases)
  • Get a Testcase (/testcase/{testcase_id})
  • Update Testcase (/testcase/{testcase_id})
  • Delete Testcase (/testcase/{testcase_id})

• Submission Management:

  • Submit Testcase (/submit)
  • Run Testcase (/runcode)

• Leaderboard:

  • Get Leaderboard (/leaderboard)

🏁 Get Started

Directions to Install

1. Fork the repo
2. Clone it locally

$ git clone https://github.com/<GITHUB_USERNAME>/cookoff-9.0-backend.git
$ cd cookoff-9.0-backend

Prerequisites

1. Setup atlas
2. Configure env (refer .env.example)
3. Configure Makefile

Directions to Run

1. Spin up containers

$ docker compose up --build -d

2. Install sqlc

$ go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest

3. Generate sqlc schema and queries

$ make generate

4. Apply migrations

$ make apply-schema

📝 Checkout:

• Cookoff'24 Admin Portal: https://github.com/CodeChefVIT/cookoff-admin-9.0
• Cookoff'24 Portal: https://github.com/CodeChefVIT/cookoff-portal-9.0

🚀 Contributors

Vedant Matanhelia	Vaibhav Sijaria	Aman L	Jothish Kamal
Soham Mahapatra	Abhinav Anand	Aman Singh

License

Made with ❤️ by CodeChef-VIT