Skip to content

CodeChefVIT/clueminati-portal-2.0

Repository files navigation

CodeChef-VIT

Clueminati 2.0


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.

🌐 Deploy

https://clueminati24.codechefvit.com

⚙️ Tech Stack:

💡 Features:

  • Admin access to oversee and manage teams, monitor scores, and handle leaderboard updates efficiently.
  • You can either join a team or create a new one with just a few clicks.
  • A dynamic leaderboard.
  • A fully functional portal with support for gestures and compatibility across devices with varying screen resolutions.

🖼 Screenshots

Login

Login Page

Join

Join Team

Create

Create Team

Share

Share Team Code

Dashboard

Dashboard

Leaderboard

Leaderboard

Profile

View Profile

Post Start

Dashboard (Event live)

Admin Profile

Admin Profile

Score

Score Update

🏁 Get Started

  1. To get started, fork your own copy and clone the main branch. To clone a branch you can run the following:
git clone -b main https://github.com/<Your username>/clueminati-portal-2.0.git

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

  1. Run the following to install all the dependencies:
pnpm i
  1. Run the following command to create .env and modify the values as per requirements.
scp .env.example .env
  1. Update DATABASE_URL in .env with PostgreSQL database URI. Run the following command to migrate your database schema:
pnpm db:migrate
  1. To start your development server run:
pnpm dev

📝 Note:

  • Make sure you set the user role as admin in database to access all the admin specific APIs.
  • For detailed API specifications, including routes, request formats, and response examples, please refer to the documentation here.

🚀 Contributors

Aaditya

Aaditya Mahanta

GitHub LinkedIn

profilepic

Nishant Gupta

GitHub LinkedIn

profilepic

Abhinav Ganeshan

GitHub LinkedIn

profilepic

Heet Jatania

GitHub LinkedIn

profilepic

Aditi Saxena

GitHub LinkedIn

profilepic

Ruhi Doshi

GitHub LinkedIn

License

License

Made with ❤️ by CodeChef-VIT