Skip to content

Commit 10d93a5

Browse files
AqVioletAbh1noob
AqViolet
and
Abh1noob
authored
readme update (#15)
* readme update * readme update * readme update * readme update * readme update * readme update * readme update * readme update * readme-update * readme-update * Update README.md --------- Co-authored-by: Abhinav Ganeshan <56132559+Abh1noob@users.noreply.github.com>
1 parent c7ebce4 commit 10d93a5

File tree

12 files changed

+160
-41
lines changed

12 files changed

+160
-41
lines changed

‎README.md‎

Lines changed: 160 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,221 @@
1-
<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>
1+
<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>
22
</p>
33

4-
<h2 align="center"> Project Name </h2>
4+
<h2 align="center"> Clueminati 2.0 </h2>
55
<br/>
66

7-
> <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Sed euismod nisi porta lorem mollis aliquam ut. Non enim praesent elementum facilisis leo. Vitae congue eu consequat ac felis donec et odio. Elit scelerisque mauris pellentesque pulvinar pellentesque habitant morbi tristique senectus. Viverra orci sagittis eu volutpat odio facilisis mauris.
7+
> <p>Clueminati is CodeChef VIT's annual treasure hunt event, returning for its second edition in 2024. This web application facilitates team creation, score tracking, and real-time leaderboard management, providing participants with a seamless and engaging experience throughout the competition.
88
99
</p>
1010

1111
## 🌐 Deploy
1212

13-
[https://project-name.codechefvit.com/](https://project-name.codechefvit.com/)
13+
[https://clueminati24.codechefvit.com](https://clueminati24.codechefvit.com)
1414

1515
## ⚙️ Tech Stack:
1616

17-
- Next.js
18-
- TypeScript
19-
- Tailwind CSS
17+
- [Next.js](https://nextjs.org)
18+
- [TypeScript](https://www.typescriptlang.org)
19+
- [Tailwind CSS](https://tailwindcss.com)
20+
- [React Hot Toast](https://react-hot-toast.com)
21+
- [Axios](https://axios-http.com)
22+
- [Shadcn](https://ui.shadcn.com)
23+
- [NeonDB](https://neon.tech)
2024

2125
## 💡 Features:
2226

23-
- Feature 1
24-
- Feature 2
25-
- Feature 3
27+
- Admin access to oversee and manage teams, monitor scores, and handle leaderboard updates efficiently.
28+
- You can either join a team or create a new one with just a few clicks.
29+
- A dynamic leaderboard.
30+
- A fully functional portal with support for gestures and compatibility across devices with varying screen resolutions.
2631

27-
## 🖼 Screenshots
28-
29-
<p align="center">
30-
31-
#### Page 1
32-
33-
<img width="1440" alt="image" src="">
34-
35-
#### Page 2
36-
37-
<img width="1440" alt="image" src="">
3832

39-
### Page 3
33+
## 🖼 Screenshots
4034

41-
<img width="1440" alt="image" src="">
35+
<table>
36+
<tr>
37+
<td align="center">
38+
<img src="public/login.jpeg" alt="Login" width="300"/>
39+
<br/>
40+
<p>Login Page</p>
41+
</td>
42+
<td align="center">
43+
<img src="public/join.jpeg" alt="Join" width="300"/>
44+
<br/>
45+
<p>Join Team</p>
46+
</td>
47+
<td align="center">
48+
<img src="public/create.jpeg" alt="Create" width="300"/>
49+
<br/>
50+
<p>Create Team</p>
51+
</td>
52+
</tr>
53+
54+
<tr>
55+
<td align="center">
56+
<img src="public/share.jpeg" alt="Share" width="300"/>
57+
<br/>
58+
<p>Share Team Code</p>
59+
</td>
60+
<td align="center">
61+
<img src="public/dashboard.jpeg" alt="Dashboard" width="300"/>
62+
<br/>
63+
<p>Dashboard</p>
64+
</td>
65+
<td align="center">
66+
<img src="public/leaderboard.jpeg" alt="Leaderboard" width="300"/>
67+
<br/>
68+
<p>Leaderboard</p>
69+
</td>
70+
</tr>
71+
72+
<tr>
73+
<td align="center">
74+
<img src="public/profile.jpeg" alt="Profile" width="300"/>
75+
<br/>
76+
<p>View Profile</p>
77+
</td>
78+
<td align="center">
79+
<img src="public/post-start.jpeg" alt="Post Start" width="300"/>
80+
<br/>
81+
<p>Dashboard (Event live)</p>
82+
</td>
83+
<td align="center">
84+
<img src="public/admin-profile.jpeg" alt="Admin Profile" width="300"/>
85+
<br/>
86+
<p>Admin Profile</p>
87+
</td>
88+
</tr>
89+
90+
<tr>
91+
<td align="center">
92+
<img src="public/score.jpeg" alt="Score" width="300"/>
93+
<br/>
94+
<p>Score Update</p>
95+
</td>
96+
</tr>
97+
</table>
4298

43-
</p>
4499

45100
## 🏁 Get Started
46101

47-
To get started, fork your own copy and clone the master branch. To clone a branch you can run the following:
48-
102+
1) To get started, fork your own copy and clone the main branch. To clone a branch you can run the following:
49103
```bash
50-
git clone -b master https://github.com/<Your username>/<repo-name>
104+
git clone -b main https://github.com/<Your username>/clueminati-portal-2.0.git
51105
```
52106

53107
Run these commands on your bash/terminal and open it in a code editor of your choice.
54108

55-
Run the following to install all the dependencies:
56-
109+
2) Run the following to install all the dependencies:
57110
```bash
58111
pnpm i
59112
```
60113

61-
To start your development server run:
114+
3) Run the following command to create .env and modify the values as per requirements.
115+
```bash
116+
scp .env.example .env
117+
```
62118

119+
4) Update `DATABASE_URL` in `.env` with PostgreSQL database URI. Run the following command to migrate your database schema:
120+
```bash
121+
pnpm db:migrate
122+
```
123+
124+
125+
5) To start your development server run:
63126
```bash
64127
pnpm dev
65128
```
66129

67130
## 📝 Note:
131+
- Make sure you set the user role as `admin` in database to access all the admin specific APIs.
132+
- For detailed API specifications, including routes, request formats, and response examples, please refer to the documentation [here](https://documenter.getpostman.com/view/25706513/2sAXqp83bu).
133+
68134

69-
Add Note
70135

71136
## 🚀 Contributors
72137

73138
<table>
74139
<tr align="center">
75140
<td>
76141
<p align="center">
77-
<img src = "copy-github-avatar-url" width="200" height="200" alt="john" style="border: 2px solid grey; width: 170px; height: 170px">
142+
<img src = "https://avatars.githubusercontent.com/u/91564450?v=4" width="200" height="200" alt="Aaditya" style="border: 2px solid grey; width: 170px; height: 170px">
78143
</p>
79-
<p style="font-size:17px; font-weight:600;">John Doe</p>
144+
<p style="font-size:17px; font-weight:600;">Aaditya Mahanta</p>
80145
<p align="center">
81-
<a href = "https://github.com/john-doe"><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>
82-
<a href = "https://www.linkedin.com/in/john-doe/">
146+
<a href = "https://github.com/aditansh"><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>
147+
<a href = "https://www.linkedin.com/in/aadityamahanta/">
83148
<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"/>
84149
</a>
85150
</p>
86151
</td>
87-
<td>
152+
153+
<td>
88154
<p align="center">
89-
<img src = "copy-github-avatar-url" width="200" height="200" alt="john" style="border: 2px solid grey; width: 170px; height: 170px">
155+
<img src = "https://avatars.githubusercontent.com/u/84934511?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
90156
</p>
91-
<p style="font-size:17px; font-weight:600;">John Doe</p>
157+
<p style="font-size:17px; font-weight:600;">Nishant Gupta</p>
92158
<p align="center">
93-
<a href = "https://github.com/john-doe"><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>
94-
<a href = "https://www.linkedin.com/in/john-doe/">
159+
<a href = "https://github.com/NishantGupt786"><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>
160+
<a href = "https://www.linkedin.com/in/nishant-gupta-12913221b/">
95161
<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"/>
96162
</a>
97163
</p>
98-
</td>
164+
</td>
99165

166+
<td>
167+
<p align="center">
168+
<img src = "https://avatars.githubusercontent.com/u/56132559?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
169+
</p>
170+
<p style="font-size:17px; font-weight:600;">Abhinav Ganeshan</p>
171+
<p align="center">
172+
<a href = "https://github.com/Abh1noob"><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>
173+
<a href = "https://www.linkedin.com/in/abhinav-gk/">
174+
<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"/>
175+
</a>
176+
</p>
177+
</td>
178+
</tr>
179+
180+
<tr align="center">
181+
<td>
182+
<p align="center">
183+
<img src = "https://avatars.githubusercontent.com/u/64064721?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
184+
</p>
185+
<p style="font-size:17px; font-weight:600;">Heet Jatania</p>
186+
<p align="center">
187+
<a href = "https://github.com/AqViolet"><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>
188+
<a href = "https://www.linkedin.com/in/heet-jatania-4a1294275/">
189+
<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"/>
190+
</a>
191+
</p>
192+
</td>
193+
194+
<td>
195+
<p align="center">
196+
<img src = "https://avatars.githubusercontent.com/u/157038896?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
197+
</p>
198+
<p style="font-size:17px; font-weight:600;">Aditi Saxena</p>
199+
<p align="center">
200+
<a href = "https://github.com/aditisaxena259"><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>
201+
<a href = "https://www.linkedin.com/in/aditi-saxena-4674ab222/">
202+
<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"/>
203+
</a>
204+
</p>
205+
</td>
206+
207+
<td>
208+
<p align="center">
209+
<img src = "https://avatars.githubusercontent.com/u/162618504?v=4" width="200" height="200" alt="profilepic" style="border: 2px solid grey; width: 170px; height:170px">
210+
</p>
211+
<p style="font-size:17px; font-weight:600;">Ruhi Doshi</p>
212+
<p align="center">
213+
<a href = "https://github.com/ruhi-doshi"><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>
214+
<a href = "https://www.linkedin.com/in/ruhi-doshi-69542628b/">
215+
<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"/>
216+
</a>
217+
</p>
218+
</td>
100219
</tr>
101220
</table>
102221

‎public/admin-profile.jpeg‎

35.7 KB
Loading

‎public/create.jpeg‎

19.7 KB
Loading

‎public/dashboard.jpeg‎

52.6 KB
Loading

‎public/form.png‎

76.8 KB
Loading

‎public/join.jpeg‎

19.1 KB
Loading

‎public/leaderboard.jpeg‎

53 KB
Loading

‎public/login.jpeg‎

21.4 KB
Loading

‎public/post-start.jpeg‎

51.1 KB
Loading

‎public/profile.jpeg‎

34.5 KB
Loading

0 commit comments

Comments
 (0)