GrepIt: Interactive Quiz Hosting Platform

Welcome to GrepIt!

GrepIt is a dynamic and interactive quiz hosting platform that brings people together for an engaging quizventure. With extensive socket communication, seamless room creation, and a plethora of features, GrepIt is designed to make your quiz experience memorable and enjoyable.

Here's the links to the frontend and the backend repos that were hosted on OpenCode '23, one of the largest open-source competitions held in North-India! The repos combined garnered 40 forks, received 25 stars, and processed nearly 100 impactful PRs, with the help of 25+ impactful collaborators!

Frontend: https://github.com/opencodeiiita/GrepIt-Frontend

Backend: https://github.com/opencodeiiita/GrepIt-Backend

Features

🚀 Room Creation and Joining

• Create Your Realm: Easily create quiz rooms and set the stage for a unique quizventure experience.
• Join with Codes: Join rooms using randomly generated codes, connecting you with other knowledge seekers.

📡 Real-time Socket Communication

• Dynamic Question Display: Questions magically appear on participants' screens in real-time, creating a synchronized quiz experience.
• Instant Answer Checking: Receive instant feedback on your answers, keeping the competition fierce and exciting.
• Leaderboard Updates: Witness the leaderboard evolve in real-time as participants showcase their quiz prowess.

💬 Chatroom Magic

• Post-Quiz Chat: Engage in lively discussions with other participants in the chatroom after the quiz ends.
• Room Announcements: Receive important updates and announcements from the room admin.

🌐 Database Integration with Planetscale and Prisma ORM

• Secure Data Storage: Your quiz data is securely stored in a Planetscale database, ensuring data integrity and reliability.
• Efficient Querying: Utilize Prisma ORM to interact with the database, making data retrieval and manipulation a breeze.

🛠️ Admin Controls

• Room Management: Admins have the power to disconnect users, make room announcements, and shape the quiz experience.
• Quiz Customization: Set timer durations, customize quiz themes, and manage the overall flow of the quiz.

Getting Started

1. Clone the Repository:

   git clone https://github.com/yourusername/grepit.git
   cd grepit

2. Install Dependencies:

   npm install

3. Set Up Database:

   • Create a Planetscale account and set up your database.
   • Configure the connection details in the .env file.

4. Run the Application:

   npm start

5. Visit GrepIt: Open your browser and navigate to http://localhost:3000 to start your quizventure!

Contributing

We welcome contributions! Whether you're a wizard in JavaScript, a sorcerer in design, or a bard in documentation, there's a place for you in the GrepIt community. Check out our Contributing Guidelines to get started.

License

GrepIt is licensed under the MIT License. Feel free to use, modify, and distribute the code as you see fit.

Let the quizventure begin! 🚀✨