{"id":16167096,"url":"https://github.com/timroes/quiz","last_synced_at":"2025-11-12T22:04:08.513Z","repository":{"id":22341798,"uuid":"25677528","full_name":"timroes/quiz","owner":"timroes","description":"A web based quiz software.","archived":false,"fork":false,"pushed_at":"2020-09-05T19:25:30.000Z","size":6905,"stargazers_count":11,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T13:07:50.794Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/timroes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-24T07:51:52.000Z","updated_at":"2020-08-13T17:38:37.000Z","dependencies_parsed_at":"2022-08-21T03:30:18.531Z","dependency_job_id":null,"html_url":"https://github.com/timroes/quiz","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fquiz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fquiz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fquiz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timroes%2Fquiz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timroes","download_url":"https://codeload.github.com/timroes/quiz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243955715,"owners_count":20374372,"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":[],"created_at":"2024-10-10T03:06:04.145Z","updated_at":"2025-11-12T22:04:03.471Z","avatar_url":"https://github.com/timroes.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Quiz\n====\n\nThis is a web based application to host a quiz.\n\nHow to use\n----------\n\n*Requirements: Python (2.7+), Modern Browser*\n\nIf you just want to use it (and not developing for it) you can just download\nthe most recent release from the [release page](../../releases) (there is no use in downloading the source code).\n\nUnzip the file to a folder of your choice. You can now create multiple quizzes\nin the `quizzes` subdirectory (see below).\n\nTo start the game, execute the `server.py` script. It will output an URL, that you\ncan now open in a modern browser (most browsers will go into fullscreen on \u003ckbd\u003eF11\u003c/kbd\u003e).\n\n### Create quizzes\n\nTo create a new quiz, create a new folder (with a name of your choice) in the `quizzes`\ndirectory (no matter if you are using a downloaded version or if you are developing\nwith the source code).\n\nPlace a file named `quiz.json` inside that directory. This JSON files describes your quiz\nand looks as follows:\n\n```JSON\n{\n  \"title\": \"Title of the quiz\",\n  \"items\": [\n  \t...\n  ]\n}\n```\n\nThe `items` array contains all the questions (and similiar) in the order\nthey should appear in the quiz. Each item is an object, that has to have at\nleast a `type` key. Depending on the `type` it must or can have other fields.\n\n#### Item types\n\nThe following item `type`s exists and can/must have the following fields:\n\n* `interlude` - A title like screen (that is no question).\n  * `title` - The title that should be shown on the interlude screen.\n  * `subtitle` (optional) - A subtitle that should be shown below.\n* `image` - A question inside an image.\n  * `image` - A path (relative or absolute) to the image.\n  * `points` - An amount of points that will be awared for the answer to this question.\n  * `solution` - The solution to the question.\n  * `label` (optional) - A label (like a question) that will be shown above the image.\n  * `source` (optional) - A source (or copyright) of the image. Will be shown subtle below the image.\n\n### Play the game\n\nWhen opening the game URL you can choose one of the quizzes you created.\n\n#### Settings\n\nOn the top right of the screen you can open the **Settings** dialog.\nYou can set the keys used to control the game in there. These keys will be\nreferred to as \u003ckbd\u003enext\u003c/kbd\u003e, \u003ckbd\u003ecorrect\u003c/kbd\u003e, \u003ckbd\u003ewrong\u003c/kbd\u003e and \u003ckbd\u003eend game\u003c/kbd\u003e key later.\n\nSettings will be saved even when you refresh, restart your browser or the server.\n\n#### Teams\n\nYou can add as many teams as you need on the top left.\n\nIf you press the icon on the bottom right of a team box, you get into the team settings.\n\nYou can change the team name, manually adjust a teams points, set a buzzer key for that team\nor delete the team from the game.\n\n#### Controls\n\nWhile you are in a game, you can control the game as follows:\n\nPress \u003ckbd\u003enext\u003c/kbd\u003e during the title screen, an *interlude* or when a solution is shown to jump to\nthe next question. When pressing \u003ckbd\u003enext\u003c/kbd\u003e while a question is shown, it will show the solution\nwithout awarding the points to any team.\n\nWhen a question is shown the teams can press their buzzer keys if they want to solve it.\nThe team box of the team, that buzzered first will be colored. If the team answered correctly\npress the \u003ckbd\u003ecorrect\u003c/kbd\u003e key. The team will be awared by the specific amount of points and the\nanswer will be shown. If the team answered wrong press the \u003ckbd\u003ewrong\u003c/kbd\u003e key. The team will be\nblocked from buzzing for a specific amount of time (indicated by a red progress line in the team\nbox).\n\nIf either the last question has been reached or at any time you press the \u003ckbd\u003eend game\u003c/kbd\u003e button,\nthe game ends and the result will be shown.\n\nHow to develop\n--------------\n\n*Requirements: NodeJS, npm, Modern Browser*\n\nTo develop the game make sure you have NodeJS and gulp (`npm install -g gulp`) installed.\n\nUsing Ubuntu you also need the nodejs-legacy package.\n\nAll dependencies will be installed automatically if you do a `npm install` in the root directory of this project.\n\nUse `gulp` or `gulp serve` to run the game and watch for changes (except changes on the quizzes).\n\nUse `gulp package` to package a zip file with your current quizzes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimroes%2Fquiz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimroes%2Fquiz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimroes%2Fquiz/lists"}