Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nymanjens/quizmaster
A web-app for conducting a quiz over the internet
https://github.com/nymanjens/quizmaster
quiz selfhosted website
Last synced: 2 months ago
JSON representation
A web-app for conducting a quiz over the internet
- Host: GitHub
- URL: https://github.com/nymanjens/quizmaster
- Owner: nymanjens
- License: other
- Created: 2019-10-14T13:24:42.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T13:05:46.000Z (about 1 year ago)
- Last Synced: 2024-05-01T23:35:14.672Z (9 months ago)
- Topics: quiz, selfhosted, website
- Language: Scala
- Homepage:
- Size: 7.61 MB
- Stars: 206
- Watchers: 4
- Forks: 30
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Quizmaster
[](https://github.com/nymanjens/quizmaster/actions)
A web-app for conducting a quiz, including a page for players to enter their answers. Lots of
question types are suported, which are configured in a YAML file.
## Screenshot
## Installation
### From prebuilt release in zip file (recommended)
- Install Java 11 (JDK 11) on your server
- Download "Binaries (compiled files) with demo configuration" from the [latest
release](https://github.com/nymanjens/quizmaster/releases)
- Unpack the archive and open a terminal in the unpacked folder
- Run `bin/server` (UNIX) or `bin/server.bat` (Windows)
- Browse to http://localhost:9000
### Using a prebuilt docker image
- Run the following commands:
```
git clone https://github.com/nymanjens/quizmaster.git
cd quizmaster
docker-compose --file=docker-compose-prebuilt.yml up
```
- Browse to http://localhost:9000
### Building and running your own release with Docker
- Run the following commands:
```
git clone https://github.com/nymanjens/quizmaster.git
cd quizmaster
docker-compose --file=docker-compose-build-locally.yml up
```
- Browse to http://localhost:9000
## Configuration
- `conf/quiz/quiz-config.yml`:
Configure your quiz here (questions, choices, answers, images, ...). The existing one in the
release is a demo config that contains most of the options.
## Play
### How to set up
Follow these steps to host a quiz:
- Make your own quiz by editing `conf/quiz/quiz-config.yml`. You can test your quiz by starting a
local server with it (see the installation section above)
- Host the server somewhere accessible to all players
- During a quiz, share the link to your server with all players. You
can go to the same page and unlock the master controls via the padlock icon (if you configured a
`masterSecret` in `quiz-config.yml`). The important pages during the quiz:
- The player's answer submission page: This is what players use to input their answers.
- The quiz page: This is the screen to show to all players. It shows the questions, player
scores and plays audio and video.
- The master page: This is a screen only for the quizmaster. It allows you to score player
answers and generally control the quiz flow.
### Shortcuts
- **Quiz navigation**
- `left/right`: Go to the previous/next step of the question
- `alt + left/right`: Go to the previous/next question
- `alt + shift + left/right`: Go to the previous/next round
- **Tools during question**
- `spacebar`: Pause and resume the timer
- `shift + r`: Play the current audio/video file from the beginning
- `shift + -/o`: Subtract 30 seconds from the current timer
- `shift + =/+/p`: Add 30 seconds from the current timer
- `alt + enter`: Toggle enlarged image (if there is a visible image)
- `a`: toggle the answer to be visible in the master view (http://localhost:9000/app/master)