📝 Updated README.md

This commit is contained in:
Mawoka
2022-03-23 18:15:37 +01:00
parent ef04fd1f2a
commit 326780c8d7
+8 -9
View File
@@ -1,17 +1,14 @@
# 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.
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](https://classquiz.mawoka.eu?utm_medium=Github&utm_source=Readme).
It is not intended for real-life usage, although it should work.
The server is located in Karlsruhe, Germany and hosted by [netcup](https://mawoka.eu/redir?token=2).
If you want to use it in real-life,
please contact me on [my website](https://mawoka.eu/contact?utm_medium=Github&utm_source=Readme).
There is a hosted version at [ClassQuiz.Mawoka.eu](https://classquiz.mawoka.eu?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.
## Self-Host
@@ -22,7 +19,9 @@ Please see https://classquiz.mawoka.eu/docs/self-host
See https://classquiz.mawoka.eu/docs/develop
## Docs
The docs are https://classquiz.mawoka.eu/docs on the website
### Things to know about the structure
1. Everything depends on Redis (API and frontend).