README.md

🎉 Quizly - AI-Powered Quiz Game

Welcome to Quizly, the ultimate AI-powered quiz platform! 🧠 Challenge your friends, test your knowledge, and have fun with real-time gameplay and AI-generated explanations. Whether you're here to learn, compete, or just enjoy a good quiz, Quizly has you covered! 💡✨

🌟 Features

• 🤖 AI-Generated Questions: Sit back and let the AI whip up questions tailored to your skill level.
• ⚡ Real-Time Gameplay: Play live with your friends using smooth WebSocket updates.
• 📊 Score Tracker: See how you're doing with live tracking of correct and incorrect answers.
• ⏱️ Dynamic Timer: Race against the clock to keep things exciting!
• 💬 AI Explanations: Learn something new with detailed AI-generated explanations when you miss a question.
• 📱 Responsive Design: Looks amazing on your phone, tablet, or computer. Play anywhere, anytime!

🚀 Getting Started

🛠️ Setup (The Easy Way)

1. Clone the Repo 🧑‍💻
   Get the code onto your machine:

   git clone https://github.com/liamstamper/quizly.git
   cd quizly
   

2. Add .env files ⚙️
   Check out frontend/.env.example and backend/.env.example

3. Run with Docker 🐳
   Let Docker do all the heavy lifting for you:

   docker compose build

   docker compose up

4. 🎉 You're Ready to Play!

   Open your browser and head over to:

   Frontend: http://localhost:5173

   Backend: http://localhost:8000/docs (for API)

🔗 Tech Stack

🌐 Frontend

• React
• TypeScript
• Tailwind CSS
• WebSockets

🛠 Backend

• FastAPI
• Python
• Redis

🙌 Acknowledgments

Quizly was built by Liam Stamper and Allen Wolf (GitHub:aaw3) during the Iowa State University Hackathon. 🎉 Thank you to everyone at Iowa State for hosting the event.