generated from CodeChefVIT/template
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #103 from JothishKamal/master
Update README.md
- Loading branch information
Showing
2 changed files
with
212 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,237 @@ | ||
| # Project cookoff-backend | ||
| <p align="center"><a href="https://www.codechefvit.com" target="_blank"><img src="https://i.ibb.co/4J9LXxS/cclogo.png" width=160 title="CodeChef-VIT" alt="Codechef-VIT"></a> | ||
| </p> | ||
|
|
||
| One Paragraph of project description goes here | ||
| <h2 align="center"> CookOff 9.0 Backend </h2> | ||
|
|
||
| ## Getting Started | ||
| <h3 align="center"> Powered By </h2> | ||
| <div align="center"> | ||
| <table> | ||
| <tr> | ||
| <td> | ||
| <div style="border: 1px solid #ccc; padding: 10px; text-align: center; border-radius: 8px; width: 200px;"> | ||
| <a href="https://discord.com/invite/GRc3v6n" target="_blank"> | ||
| <img src="https://avatars.githubusercontent.com/u/25365178?s=200&v=4" alt="Judge0" style="width:150px; height:150px; border-radius: 8px;"> | ||
| <p>Join Judge0 Discord</p> | ||
| </a> | ||
| </div> | ||
| </td> | ||
| <td> | ||
| <div style="border: 1px solid #ccc; padding: 10px; text-align: center; border-radius: 8px; width: 200px;"> | ||
| <a href="https://discord.com/invite/dCq3XhgRXs" target="_blank"> | ||
| <img src="https://pbs.twimg.com/profile_images/1742205229104259072/2ISO3o7-_400x400.jpg" alt="Sulu" style="width:150px; height:150px; border-radius: 8px;"> | ||
| <p>Join Sulu Discord</p> | ||
| </a> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </div> | ||
| <br/> | ||
|
|
||
| These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. | ||
| --- | ||
|
|
||
| ## MakeFile | ||
| > 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. | ||
| run all make commands with clean tests | ||
| --- | ||
|
|
||
| ```bash | ||
| make all build | ||
| ``` | ||
| [](https://documenter.getpostman.com/view/26244894/2sAXqtbgvt) | ||
| [](https://cookoff24.codechefvit.com/) | ||
|
|
||
| build the application | ||
| ## ⚙️ Tech Stack: | ||
|
|
||
| ```bash | ||
| make build | ||
| ``` | ||
| - [Go](https://go.dev/) | ||
| - [Docker](https://www.docker.com/) | ||
| - [PostgreSQL](https://www.postgresql.org/) | ||
| - [Redis](https://redis.io/) | ||
| - [Atlas](https://atlasgo.io/) | ||
| - [Make](https://www.gnu.org/software/make/manual/make.html) | ||
| - [SQLC](https://github.com/sqlc-dev/sqlc) | ||
|
|
||
| run the application | ||
| ## 🔧 Features | ||
|
|
||
| ```bash | ||
| make run | ||
| ``` | ||
| - 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: | ||
|
|
||
| Create DB container | ||
| - Submit Testcase (`/submit`) | ||
| - Run Testcase (`/runcode`) | ||
|
|
||
| ```bash | ||
| make docker-run | ||
| - Leaderboard: | ||
| - Get Leaderboard (`/leaderboard`) | ||
|
|
||
| ## 🏁 Get Started | ||
|
|
||
| ### Directions to Install | ||
|
|
||
| 1. Fork the repo | ||
| 2. Clone it locally | ||
|
|
||
| ```sh | ||
| $ git clone https://github.com/<GITHUB_USERNAME>/cookoff-9.0-backend.git | ||
| $ cd cookoff-9.0-backend | ||
| ``` | ||
|
|
||
| Shutdown DB container | ||
| ### Prerequisites | ||
|
|
||
| ```bash | ||
| make docker-down | ||
| 1. Setup atlas | ||
| 2. Configure env (refer .env.example) | ||
| 3. Configure Makefile | ||
|
|
||
| ### Directions to Run | ||
|
|
||
| 1. Spin up containers | ||
|
|
||
| ```sh | ||
| $ docker compose up --build -d | ||
| ``` | ||
|
|
||
| live reload the application | ||
| 2. Install sqlc | ||
|
|
||
| ```bash | ||
| make watch | ||
| ```sh | ||
| $ go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest | ||
| ``` | ||
|
|
||
| run the test suite | ||
| 3. Generate sqlc schema and queries | ||
|
|
||
| ```bash | ||
| make test | ||
| ```sh | ||
| $ make generate | ||
| ``` | ||
|
|
||
| clean up binary from the last build | ||
| 4. Apply migrations | ||
|
|
||
| ```bash | ||
| make clean | ||
| ```sh | ||
| $ make apply-schema | ||
| ``` | ||
|
|
||
| ## 📝 Checkout: | ||
|
|
||
| - Cookoff'24 Admin Portal: [https://github.com/CodeChefVIT/cookoff-admin-9.0](https://github.com/CodeChefVIT/cookoff-admin-9.0) | ||
| - Cookoff'24 Portal: [https://github.com/CodeChefVIT/cookoff-portal-9.0](https://github.com/CodeChefVIT/cookoff-portal-9.0) | ||
|
|
||
| ## 🚀 Contributors | ||
|
|
||
| <table> | ||
| <tr align="center"> | ||
| <td> | ||
| <p align="center"> | ||
| <img src = "https://avatars.githubusercontent.com/u/71623796?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px"> | ||
| </p> | ||
| <p style="font-size:17px; font-weight:600;">Vedant Matanhelia</p> | ||
| <p align="center"> | ||
| <a href = "https://github.com/Xenomorph07"><img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/></a> | ||
| <a href = "https://www.linkedin.com/in/vedant-matanhelia-aa171027b/"> | ||
| <img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/> | ||
| </a> | ||
| </p> | ||
| </td> | ||
|
|
||
| <td> | ||
| <p align="center"> | ||
| <img src = "https://avatars.githubusercontent.com/u/139199971?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px"> | ||
| </p> | ||
| <p style="font-size:17px; font-weight:600;">Vaibhav Sijaria</p> | ||
| <p align="center"> | ||
| <a href = "https://github.com/vaibhavsijaria"><img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/></a> | ||
| <a href = "https://www.linkedin.com/in/vaibhav-sijaria/"> | ||
| <img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/> | ||
| </a> | ||
| </p> | ||
| </td> | ||
|
|
||
| <td> | ||
| <p align="center"> | ||
| <img src = "https://avatars.githubusercontent.com/u/86644389?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px"> | ||
| </p> | ||
| <p style="font-size:17px; font-weight:600;">Aman L</p> | ||
| <p align="center"> | ||
| <a href = "https://github.com/Killerrekt"><img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/></a> | ||
| <a href = "https://www.linkedin.com/in/aman-l-922819251/"> | ||
| <img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/> | ||
| </a> | ||
| </p> | ||
| </td> | ||
|
|
||
| <td> | ||
| <p align="center"> | ||
| <img src = "https://avatars.githubusercontent.com/u/74227363?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px"> | ||
| </p> | ||
| <p style="font-size:17px; font-weight:600;">Jothish Kamal</p> | ||
| <p align="center"> | ||
| <a href = "https://github.com/JothishKamal"><img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/></a> | ||
| <a href = "https://www.linkedin.com/in/jothishkamal/"> | ||
| <img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/> | ||
| </a> | ||
| </p> | ||
| </td> | ||
|
|
||
| </tr> | ||
| <td> | ||
| <p align="center"> | ||
| <img src = "https://avatars.githubusercontent.com/u/155614230?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px"> | ||
| </p> | ||
| <p style="font-size:17px; font-weight:600;">Soham Mahapatra</p> | ||
| <p align="center"> | ||
| <a href = "https://github.com/Soham-Maha"><img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/></a> | ||
| <a href = "https://www.linkedin.com/in/soham-mahapatra-433bb428a/"> | ||
| <img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/> | ||
| </a> | ||
| </p> | ||
| </td> | ||
|
|
||
| <td> | ||
| <p align="center"> | ||
| <img src = "https://avatars.githubusercontent.com/u/140488187?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px"> | ||
| </p> | ||
| <p style="font-size:17px; font-weight:600;">Abhinav Anand</p> | ||
| <p align="center"> | ||
| <a href = "https://github.com/Abhinav-055"><img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/></a> | ||
| <a href = "https://www.linkedin.com/in/abhinav-anand--/"> | ||
| <img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/> | ||
| </a> | ||
| </p> | ||
| </td> | ||
|
|
||
| <td> | ||
| <p align="center"> | ||
| <img src = "https://avatars.githubusercontent.com/u/80804989?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px"> | ||
| </p> | ||
| <p style="font-size:17px; font-weight:600;">Aman Singh</p> | ||
| <p align="center"> | ||
| <a href = "https://github.com/DevloperAmanSingh"><img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/></a> | ||
| <a href = "https://www.linkedin.com/in/amansingh2112/"> | ||
| <img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| <tr> | ||
|
|
||
| </tr> | ||
| </table> | ||
|
|
||
| ## License | ||
|
|
||
| [](http://badges.mit-license.org) | ||
|
|
||
| <p align="center"> | ||
| Made with :heart: by <a href="https://www.codechefvit.com" target="_blank">CodeChef-VIT</a> | ||
| </p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters