classquiz-ai/README.md

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.Mawoka.eu. It is not intended for real-life usage, although it should work. The server is located in Karlsruhe, Germany and hosted by netcup. If you want to use it in real-life, please contact me on my website.

Self-Host

1. Clone this repo: git clone https://github.com/mawoka-myblock/ClassQuiz.git
2. Edit frontend/Dockerfile and set in line 7 (REDIS_URL=) to a valid redis-dsn. I use Upstash for that.
3. Customize the docker-compose.yml to your needs
4. Build the docker-images: docker compose build
5. Lastly, start it: docker compose up -d

Things to know about the structure

1. Everything depends on Redis (API and frontend).
2. The proxy-container is optional (Caddy), but makes your life easier
3. You need to set your reverse proxy up, so that it allows Socket.io-connections.

---

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