Welcome to the QuizCast GitHub Organization! This organization hosts the repositories for QuizCast, a dynamic and interactive platform that allows users to create, host, and participate in real-time quiz challenges.
QuizCast is a feature-rich platform designed to deliver a seamless quiz experience. Whether you want to host a quiz or participate in one, QuizCast makes it easy, intuitive, and engaging. The platform leverages Supabase for real-time updates, authentication, and data management, ensuring that every interaction is smooth and efficient.
- User Authentication: Powered by Supabase with secure JWT token-based authentication.
- Real-Time Updates: Leaderboards, quiz broadcasts, and live submissions powered by Supabase Realtime.
- Create and Join Quizzes: Hosts can create quizzes, and participants can join using a unique quiz key.
- Profile Management: Hosts can upload profile pictures, stored securely in Supabase S3 buckets.
- Responsive Design: Built with Flowbite and Tailwind CSS for a clean and modern UI.
- Open Source: Fully open-source under the MIT License.
The frontend of QuizCast is built using Next.js and styled with Tailwind CSS and Flowbite. It provides an intuitive user interface for hosts and participants, featuring real-time updates and seamless interaction with the backend.
- Key Technologies: Next.js, Tailwind CSS, Flowbite, Supabase JS SDK
- Hosted On: Vercel
- Realtime leaderboard updates.
- Quiz hosting and participation.
- Supabase integration for authentication and real-time broadcasting.
The backend is built with FastAPI, serving as the core of QuizCast's operations. It manages authentication, quiz creation, user data, and leaderboard calculations while integrating with Supabase for database operations.
- Key Technologies: Python, FastAPI, Supabase
- Deployment Options: Local, Docker
- User authentication with Supabase JWT tokens.
- API endpoints for quiz and user management.
- Realtime updates via Supabase PostgreSQL changes.
-
Create an Account:
- Users can sign up or log in using Supabase-powered authentication.
-
Host a Quiz:
- Create a quiz, add questions, and share the unique quiz key with participants.
-
Join a Quiz:
- Enter the quiz key to join an active quiz.
-
Real-Time Fun:
- Participants answer questions in real time while the leaderboard updates dynamically.
We are an open-source organization and welcome contributions from the community! Here's how you can contribute:
- Fork the repository you'd like to contribute to.
- Clone it to your local machine:
git clone https://github.com/your-username/repository-name.git
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit:
git commit -m "Add your descriptive message here"
- Push your changes:
git push origin feature/your-feature-name
- Create a pull request to the main repository.
All projects under the QuizCast organization are licensed under the MIT License. Feel free to use, modify, and distribute our code.
Have questions or feedback? Feel free to open an issue in any of our repositories or contact us directly. We’re excited to hear from you and improve together!
Join us on this journey to redefine real-time quizzes! 🎊