Quizz-Us

A multiplayer quiz game platform.

What is it?

Quizz-Us lets you host and play quiz games with multiple players in real-time. Create your own questions or use the provided quiz data.

Quick Start

Option 1: Using Docker (Recommended)

Prerequisites: Docker and Docker Compose

docker-compose up

Then open your browser to:

• Frontend: http://localhost:3001
• Backend API: http://localhost:8080

Option 2: Local Development

Prerequisites: Go 1.20+ and Node.js

1. Start the backend:

   make run-backend

2. Start the frontend (new terminal):

   make run-frontend

3. Open your browser and navigate to the URL shown.

How to Play

Players: Join using a game code, answer questions, and see your score in real-time.

Hosts: Start a server, share the game code, and manage the quiz session.

Custom Questions

Edit quiz-data.yaml to add your own questions:

- question: "Your question here?"
  answer: "The answer"
  tags: ["category"]

Documentation

For Developers:

• Developer Guide
• Developer README
• Admin Guide

Technical Design:

• Game Engine
• Architecture Diagram
• Game Handler Flow
• Requirements
• Frontend