GitHub Repo stars GitHub contributors GitHub forks GitHub issues GitHub GitHub code size in bytes [![DeepSource](https://deepsource.io/gh/mawoka-myblock/ClassQuiz.svg/?label=active+issues&show_trend=true&token=5-2Na9HN-2CXcGkHjah_Rk09&style=for-the-badge)](https://deepsource.io/gh/mawoka-myblock/ClassQuiz/) Snky badge [![codecov](https://codecov.io/gh/mawoka-myblock/ClassQuiz/branch/master/graph/badge.svg?token=7CHK2A0AMO)](https://codecov.io/gh/mawoka-myblock/ClassQuiz)

ClassQuiz

ClassQuiz Logo

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

Docs · Register · Self-Hosting · Matrix Space

## 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](https://classquiz.de?utm_medium=Github&utm_source=Readme). The server is located in Karlsruhe, Germany and hosted by [netcup](https://mawoka.eu/redir?token=2), so expect some latency depending on your location. ## Help/Community Join our [Matrix Space](https://matrix.to/#/#classquiz:matrix.org) using [element](https://app.element.io)! ## Donating [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K3CK3ES) ## Self-Host Please see https://classquiz.de/docs/self-host ## Development See https://classquiz.de/docs/develop ## Translation ClassQuiz uses [hosted Weblate](https://hosted.weblate.org/engage/classquiz/) Übersetzungsstatus ## 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/`](https://github.com/mawoka-myblock/ClassQuiz/tree/master/frontend)-directory. The backend-project (Pipfile) is in the root, but all the code is located in the [`classquiz/`](https://github.com/mawoka-myblock/ClassQuiz/tree/master/frontend)-folder. #### Tech-Stack ##### Backend The backend is made with [FastAPI](https://fastapi.tiangolo.com/) (web-framework) , [ormar](https://github.com/collerek/ormar/) (ORM) , [python-socketio](https://python-socketio.readthedocs.io/en/latest/) (realtime-communication between server and client) ##### Frontend The frontend is made with [SvelteKit](https://kit.svelte.dev/) (web-framework) and [TailwindCSS](https://tailwindcss.com/) (Css-Framework). ##### External Dependencies Selfhostable: - [Meilisearch](https://www.meilisearch.com/) (Search-Server) - [Caddy](https://caddyserver.com/) (Reverse Proxy) - [Postgres](https://www.postgresql.org/) (Database) - [Redis](https://redis.io/) (Cache) Closed-Source 3rd parties: - [Mapbox](https://www.mapbox.com/) (maps) - [hCaptcha](https://www.hcaptcha.com/) (captcha) --- ## License Note This repository is licensed under the [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/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!**