Skip to main content

​
Welcome to ClassQuiz

ClassQuiz is an open-source quiz platform designed for interactive learning. Teachers can create engaging quizzes while students compete in real-time, making learning fun and collaborative.
1

Register Your Account

Navigate to the ClassQuiz registration page at /account/register or visit classquiz.de/account/register.

​
Required Information

Fill out the registration form with:
  • Email address: A valid email for account verification
  • Username: 3-20 characters, unique identifier
  • Password: Minimum 8 characters, maximum 100 characters
  • Password confirmation: Must match your password
You must accept both the Privacy Policy and Terms of Service to create an account.

​
Email Verification

After submitting the form, check your mailbox for a verification email. Click the confirmation link to activate your account.
If email verification is disabled on your self-hosted instance (SKIP_EMAIL_VERIFICATION=True), you can start using your account immediately.

​
Alternative Sign-In Methods

If enabled on your instance, you can also register using:
  • Google Account: OAuth integration for quick sign-up
  • GitHub Account: Sign in with your developer account
  • Custom OpenID Provider: If configured by your administrator
2

Access Your Dashboard

After logging in, you’ll be redirected to your dashboard at /dashboard. This is your central hub for managing quizzes.

​
Dashboard Features

From your dashboard, you can:
  • Create new quizzes or quiztivities
  • Import quizzes from Kahoot! or other sources
  • View Results from past quiz sessions
  • Manage Files in your media library
  • Access Settings to customize your account

Quiz

Live, competitive quiz sessions where students answer questions in real-time and compete for the top score.

Quiztivity

Self-paced activities where students work through questions at their own speed without competition.
3

Create Your First Quiz

Click the Create button on your dashboard, then select Quiz to start building.

​
Quiz Configuration

Set up your quiz with:
  • Title: Give your quiz a descriptive name
  • Description: Add context for your students (optional)
  • Public/Private: Control visibility in the quiz explorer
  • Cover Image: Upload or select a visual from your media library

​
Adding Questions

ClassQuiz supports multiple question types:
Standard multiple-choice questions with up to 4 answer options. Mark correct answers and set a time limit (e.g., 20 seconds).
Simple binary questions for quick comprehension checks.
Free-form text responses for open-ended questions.
Students arrange items in the correct sequence.
Add informational slides between questions to provide context or instructions.

​
Formatting Support

Questions support basic HTML formatting:
<b>bold</b>, <strong>strong</strong>, <i>italic</i>, <em>emphasis</em>,
<small>small</small>, <mark>highlight</mark>, <del>strikethrough</del>,
<sub>subscript</sub>, <sup>superscript</sup>

​
Media Support

Enhance questions with:
  • Images: PNG, JPEG, GIF, WebP formats
  • Videos: MP4 format
Upload media to your file library at /edit/files for reuse across quizzes.
Keep media file sizes reasonable to ensure smooth gameplay, especially for students with slower connections.
4

Start Your Quiz Game

Once your quiz is ready, click the Play button (▶️) from your dashboard.

​
Game Setup

  1. Choose Game Mode:
    • Standard: Classic competitive format
    • Custom: Adjust settings for your needs
  2. Share Game PIN: Students join at /play by entering the unique game code
  3. Wait for Players: Monitor the lobby as students join
  4. Start Game: Begin when all students are ready

​
During the Game

As the quiz host, you’ll:
  • Advance through questions at your pace
  • See live answer submissions
  • Display results after each question
  • View the real-time leaderboard

​
Student Experience

Students navigate to /play and:
  1. Enter the game PIN
  2. Choose a username (3-20 characters)
  3. Wait in the lobby for the game to start
  4. Answer questions as they appear
  5. See their score and ranking after each question
Students can rejoin a game if disconnected - their session is saved via cookies for up to 1 hour.
5

Review Results

After the quiz ends, access detailed analytics at /results/[result_id].

​
Results Dashboard

The results page includes three tabs:

​
Overview Tab

  • Quiz title and timestamp
  • Player scores and rankings
  • Summary statistics

​
Players Tab

  • Individual student performance
  • Custom field data (if configured)
  • Per-player answer breakdown

​
Questions Tab

  • Question-by-question analysis
  • Answer distribution
  • Correct answer percentages
Access all your past quiz results from the Results button on your dashboard at any time.

​
Download Results

Export quiz data for further analysis:
  • Click the download button (⬇️) on your dashboard
  • Save in ClassQuiz’s native .cqa format
  • Import into other ClassQuiz instances or use for backup

​
Next Steps

Import from Kahoot!

Migrate your existing Kahoot! quizzes to ClassQuiz

Self-Hosting

Deploy your own ClassQuiz instance with Docker

Community Features

Browse and share quizzes in the public marketplace

API Reference

Integrate ClassQuiz with your applications

​
Tips for Great Quizzes

Set time limits based on question complexity:
  • Simple multiple choice: 10-15 seconds
  • Complex questions requiring reading: 30-60 seconds
  • Text input questions: 45-90 seconds
  • Add cover images to make quizzes visually appealing
  • Use images in questions to test visual comprehension
  • Keep file sizes under 2MB for best performance
  • Preview your quiz on mobile to ensure readability
  • Mix question types to maintain interest
  • Add slides between sections to provide context
  • Use the description field to explain objectives
  • Test your quiz before using it with students
  • Use descriptive titles for easy searching
  • Organize media files in your file library
  • Make quizzes public to share with the community
  • Download backups of your important quizzes

​
Get Help

Community Support

Join the Matrix Space for community help and discussions

Report Issues

Found a bug? Report it on GitHub

Build docs developers (and LLMs) love

Get started for freeTalk to us