{"id":13674433,"url":"https://github.com/nymanjens/quizmaster","last_synced_at":"2025-04-28T14:31:27.954Z","repository":{"id":42433684,"uuid":"215050450","full_name":"nymanjens/quizmaster","owner":"nymanjens","description":"A web-app for conducting a quiz over the internet","archived":false,"fork":false,"pushed_at":"2023-11-23T13:05:46.000Z","size":7976,"stargazers_count":206,"open_issues_count":2,"forks_count":30,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-01T23:35:14.672Z","etag":null,"topics":["quiz","selfhosted","website"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nymanjens.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":["nymanjens"]}},"created_at":"2019-10-14T13:24:42.000Z","updated_at":"2024-04-24T01:32:17.000Z","dependencies_parsed_at":"2023-11-23T14:25:07.283Z","dependency_job_id":"19bdea97-d983-4d4f-8100-95086df55b6a","html_url":"https://github.com/nymanjens/quizmaster","commit_stats":null,"previous_names":[],"tags_count":158,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nymanjens%2Fquizmaster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nymanjens%2Fquizmaster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nymanjens%2Fquizmaster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nymanjens%2Fquizmaster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nymanjens","download_url":"https://codeload.github.com/nymanjens/quizmaster/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224120186,"owners_count":17259026,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["quiz","selfhosted","website"],"created_at":"2024-08-02T11:00:50.294Z","updated_at":"2025-04-28T14:31:27.941Z","avatar_url":"https://github.com/nymanjens.png","language":"Scala","funding_links":["https://github.com/sponsors/nymanjens"],"categories":["Software","website"],"sub_categories":["Games"],"readme":"# Quizmaster\n\n[![CI Status](https://github.com/nymanjens/quizmaster/actions/workflows/ci.yml/badge.svg)](https://github.com/nymanjens/quizmaster/actions)\n\nA web-app for conducting a quiz, including a page for players to enter their answers. Lots of\nquestion types are suported, which are configured in a YAML file.\n\n## Screenshot\n\n![screenshot](screenshot.png \"Screenshot\")\n\n## Installation\n\n### From prebuilt release in zip file (recommended)\n\n- Install Java 11 (JDK 11) on your server\n- Download \"Binaries (compiled files) with demo configuration\" from the [latest\n  release](https://github.com/nymanjens/quizmaster/releases)\n- Unpack the archive and open a terminal in the unpacked folder\n- Run `bin/server` (UNIX) or `bin/server.bat` (Windows)\n- Browse to http://localhost:9000\n\n### Using a prebuilt docker image\n\n- Run the following commands:\n\n```\ngit clone https://github.com/nymanjens/quizmaster.git\ncd quizmaster\ndocker-compose --file=docker-compose-prebuilt.yml up\n```\n\n- Browse to http://localhost:9000\n\nTip: After updating `quiz-config.yml`, you can force recreate the containers as\nfollows:\n\n```\ndocker-compose --file=docker-compose-prebuilt.yml up --force-recreate\n```\n\n### Building and running your own release with Docker\n\n\n- Run the following commands:\n\n```\ngit clone https://github.com/nymanjens/quizmaster.git\ncd quizmaster\ndocker-compose --file=docker-compose-build-locally.yml up\n```\n- Browse to http://localhost:9000\n\n## Configuration\n\n- `conf/quiz/quiz-config.yml`:\u003cbr\u003e\n  Configure your quiz here (questions, choices, answers, images, ...). The existing one in the\n  release is a demo config that contains most of the options.\n\n\n## Play\n\n### How to set up\n\nFollow these steps to host a quiz:\n\n- Make your own quiz by editing `conf/quiz/quiz-config.yml`. You can test your quiz by starting a\n  local server with it (see the installation section above)\n- Host the server somewhere accessible to all players\n- During a quiz, share the link to your server with all players. You\n  can go to the same page and unlock the master controls via the padlock icon (if you configured a\n  `masterSecret` in `quiz-config.yml`). The important pages during the quiz:\n  - The player's answer submission page: This is what players use to input their answers.\n  - The quiz page: This is the screen to show to all players. It shows the questions, player\n    scores and plays audio and video.\n  - The master page: This is a screen only for the quizmaster. It allows you to score player\n    answers and generally control the quiz flow.\n\n### Shortcuts\n\n- **Quiz navigation**\n  - `left/right`: Go to the previous/next step of the question\n  - `alt + left/right`: Go to the previous/next question\n  - `alt + shift + left/right`: Go to the previous/next round\n- **Tools during question**\n  - `spacebar`: Pause and resume the timer\n  - `shift + r`: Play the current audio/video file from the beginning\n  - `shift + -/o`: Subtract 30 seconds from the current timer\n  - `shift + =/+/p`: Add 30 seconds from the current timer\n  - `alt + enter`: Toggle enlarged image (if there is a visible image)\n  - `a`: toggle the answer to be visible in the master view (http://localhost:9000/app/master)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnymanjens%2Fquizmaster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnymanjens%2Fquizmaster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnymanjens%2Fquizmaster/lists"}