Skip to content

Commit 7f05c26

Browse files
committed
feat: add features
1 parent b6c6da8 commit 7f05c26

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
</tr>
2727
</table>
2828
</div>
29+
<br/>
2930

3031
> This is the backend for the cookoff coding portal for the 9th edition of cookoff. (first working portal :skull:)
3132
@@ -36,7 +37,32 @@
3637

3738
## Features
3839

39-
- Insert list of features here
40+
### User
41+
- Sign Up (```/user/signup```)
42+
- Login (```/user/login```)
43+
44+
### Questions
45+
- Create Question (```/question/create```)
46+
- Get all Questions (```/questions```)
47+
- Get a Question (```/question/{question_id}```)
48+
- Get Question by Round (```/question/round```)
49+
- Update Question (```/question```)
50+
- Delete Question (```/question/{question_id}```)
51+
52+
### Testcases
53+
- Create Testcase (```/testcase```)
54+
- Get Testcases by Question (```/questions/{question_id}/testcases```)
55+
- Get a Testcase (```/testcase/{testcase_id}```)
56+
- Update Testcase (```/testcase/{testcase_id}```)
57+
- Delete Testcase (```/testcase/{testcase_id}```)
58+
59+
### Submissions
60+
- Submit Testcase (```/submit```)
61+
- Run Testcase (```/runcode```)
62+
63+
### Leaderboard
64+
- Get Leaderboard (```/leaderboard```)
65+
4066

4167
## Dependencies
4268

@@ -53,7 +79,7 @@ $ git clone https://github.com/CodeChefVIT/cookoff-9.0-backend.git
5379
$ cd cookoff-9.0-backend
5480
```
5581

56-
#### Pre-requisites
82+
#### Prerequisites
5783

5884
1. Setup atlas
5985
2. Configure env (refer .env.example)
@@ -65,6 +91,14 @@ $ cd cookoff-9.0-backend
6591
$ docker compose up --build -d
6692
```
6793

94+
```sh
95+
$ go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
96+
```
97+
98+
```sh
99+
$ make generate
100+
```
101+
68102
```sh
69103
$ make apply-schema
70104
```

0 commit comments

Comments
 (0)