kahiin

An open source game for school classes, with server runnable on any terminal.

Installation

Easy way (Docker)

1. Install Docker
2. Run the following command:

docker build -t kahiin .
sudo docker volume create kahiin
docker run --network=host -v kahiin:/kahiin/quiz kahiin

Manual way (Only for Linux)

1. Install Python
2. Run the installation script:

bash start.sh

Credits

• Javascript libraries

  • Socket.IO: Used for server-client communication.

  • CryptoJS 4.1.1: Used to hash passwords.

  • Application Icon: Made using Microsoft Copilot

  • Marked: Used for rendering Markdown.

  • KaTeX: Used for rendering mathematical formulas.

    • KaTeX CSS
    • KaTeX JS
    • KaTeX Auto-render

• Python modules

  • Flask: The webframework hosting the server.

  • Flask-SocketIO: Handle socket.IO requests

  • qrcode: Used to generate the qrcode in the board page.