ClassQuiz

<!-- SPDX-FileCopyrightText: 2023 Marlon W (Mawoka) SPDX-License-Identifier: MPL-2.0 -->

<a href="https://github.com/mawoka-myblock/ClassQuiz/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/mawoka-myblock/classquiz?style=for-the-badge"></a> <a href="https://github.com/mawoka-myblock/ClassQuiz/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/mawoka-myblock/classquiz?color=green&style=for-the-badge"></a> <a href="https://github.com/mawoka-myblock/ClassQuiz/network/members"><img alt="GitHub forks" src="https://img.shields.io/github/forks/mawoka-myblock/classquiz?style=for-the-badge"></a> <a href="https://github.com/mawoka-myblock/ClassQuiz/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc"><img alt="GitHub issues" src="https://img.shields.io/github/issues/mawoka-myblock/classquiz?style=for-the-badge"></a> <a href="https://github.com/mawoka-myblock/ClassQuiz/blob/master/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/mawoka-myblock/classquiz?style=for-the-badge"></a> <img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/mawoka-myblock/classquiz?style=for-the-badge"> <img alt="Snky badge" src="https://img.shields.io/badge/Snyk-Check-success?style=for-the-badge">

<div align='center'> <h2 align='center'>ClassQuiz</h2> <img src='logo.png' alt='ClassQuiz Logo' height='100px' width='100px'> <p align='center'> The open-source quiz-platform! <br/> <a href='https://classquiz.de/'><strong>Visit the website »</strong></a> <br /> <br /> <a href='https://classquiz.de/docs'>Docs</a> · <a href='https://classquiz.de/account/register'>Register</a> · <a href='https://classquiz.de/docs/self-host'>Self-Hosting</a> · <a href='https://matrix.to/#/#classquiz:matrix.org'>Matrix Space</a> </p> </div>

About ClassQuiz

ClassQuiz is a quiz app to learn interactively for students, 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.

Help/Community

Join our Matrix Space using element!

Donating

<a href="https://liberapay.com/Mawoka/donate"><img src="https://img.shields.io/liberapay/goal/Mawoka.svg?logo=liberapay"></a>

Self-Host

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

Development

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

Translation

ClassQuiz uses hosted Weblate

<a href="https://hosted.weblate.org/engage/classquiz/"> <img src="https://hosted.weblate.org/widgets/classquiz/-/frontend/multi-auto.svg" alt="Übersetzungsstatus" /> </a>

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)

---

License Note

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

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

[^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!