ClassQuiz

ClassQuiz copied to clipboard

ClassQuiz

The open-source quiz-platform!
Visit the website »

Docs · Register · Self-Hosting

License Note

This repository is licensed under the Mozilla Public License 2.0, so you

MUST PUBLISH ANY CHANGES YOU MAKE!!![^1]

About ClassQuiz

ClassQuiz is a quiz-application like KAHOOT!, but open-source which is very important if it is a product for educational purposes. You can create quizzes and play them remotely with other people. It is mainly made for teachers, who create a quiz, so students can compete with their knowledge against each other.

Try it

There is a hosted version at classquiz.de. The server is located in Karlsruhe, Germany and hosted by netcup, so expect some latency depending on your location.

Donating

Self-Host

Please see https://classquiz.de/docs/self-host

Development

See https://classquiz.de/docs/develop

Translation

ClassQuiz uses a Weblate-instace hosted by Mawoka.

Docs

The docs are online at https://classquiz.de/docs

Things to know about the structure

Since this repo is a monorepo, the frontend is located in the frontend/-directory. The backend-project (Pipfile) is in the root, but all the code is located in the classquiz/-folder.

Tech-Stack

Backend

The backend is made with FastAPI (web-framework) , ormar (ORM) , python-socketio (realtime-communication between server and client)

Frontend

The frontend is made with SvelteKit (web-framework) and TailwindCSS (Css-Framework).

External Dependencies

Selfhostable:

• Meilisearch (Search-Server)
• Caddy (Reverse Proxy)
• Postgres (Database)
• Redis (Cache)

Closed-Source 3rd parties:

• Mapbox (maps)
• hCaptcha (captcha)

Kahoot! and the K! logo are trademarks of Kahoot! AS

[^1]: I added this note, since people are stealing my software and changing it without providing the source-code. Maybe they aren't aware of this license, maybe they don't care, but I don't care, why they don't do it. THEY HAVE TO!