From 840262d196a1fa0ce1f31daa555a6a2e0428c973 Mon Sep 17 00:00:00 2001 From: Mawoka Date: Sun, 6 Mar 2022 17:38:57 +0100 Subject: [PATCH] :memo: Added README.md --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..89e9fa4 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# 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](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). +## 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](https://upstash.com/) 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* \ No newline at end of file