{"id":16718666,"url":"https://github.com/planeshifter/qality.js","last_synced_at":"2025-04-10T08:54:18.718Z","repository":{"id":30857005,"uuid":"34414542","full_name":"Planeshifter/qality.js","owner":"Planeshifter","description":"Multiple-Choice QA System for JavaScript ","archived":false,"fork":false,"pushed_at":"2015-11-24T06:02:13.000Z","size":4689,"stargazers_count":4,"open_issues_count":1,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-07T18:49:10.760Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://qality.philipp-burckhardt.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Planeshifter.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":"2015-04-22T20:37:22.000Z","updated_at":"2016-04-20T05:19:43.000Z","dependencies_parsed_at":"2022-09-21T03:50:40.978Z","dependency_job_id":null,"html_url":"https://github.com/Planeshifter/qality.js","commit_stats":null,"previous_names":["planeshifter/qa.js"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Fqality.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Fqality.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Fqality.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Planeshifter%2Fqality.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Planeshifter","download_url":"https://codeload.github.com/Planeshifter/qality.js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248190407,"owners_count":21062277,"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-12T21:38:03.030Z","updated_at":"2025-04-10T08:54:18.695Z","avatar_url":"https://github.com/Planeshifter.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM version][npm-image]][npm-url]\n[![Bower version][bower-image]][bower-url]\n[![Build Status][travis-image]][travis-url]\n[![Dependencies][dependencies-image]][dependencies-url]\n\n# QAlity.js\n\n\u003e Multiple-Choice QA System for JavaScript\n\n\u003cimg src=\"http://burckhardt.ludicmedia.de/Quiz02.png\"\u003e\n\n## Features:\n\n- **Versatile**: Several question types: *multiple choice*, *input fields*, *timed and untimed questions*\n- **Evaluation system**: Provide result scores and targeted feedback\n- **Animations**: customizable animations based on the performant [gsap](http://greensock.com/gsap) library\n- **Visual Editor**: create quizzes interactively using a visual frontend\n- **Markdown support**: implemented via [markdown-it](https://markdown-it.github.io/)\n- **Math support**: blazingly fast rendering via [KaTeX](http://khan.github.io/KaTeX/)\n- **Customizable Design**: change appearance of all elements via CSS\n\n## Getting Started\n\nCreate a quiz on on the [QAlity Frontend](http://qality.philipp-burckhardt.com/),\ngrab the created JavaScript object and insert on your page via one of the following options.\n\n## Installation:\n\n#### CDN\n\nInclude the following two lines in your `head` and you are ready to go:\n```html\n\u003cscript src=\"https://cdn.rawgit.com/Planeshifter/qality.js/d02a37d884cd658448ee64a058cd32ceb7df4dfb/dist/QAreader.min.js\"\u003c/script\u003e\n\u003clink href=\"https://cdn.rawgit.com/Planeshifter/qality.js/d02a37d884cd658448ee64a058cd32ceb7df4dfb/css/exam.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\"/\u003e\n```\n\nSee the following minimal working example:\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n  \u003chead\u003e\n      \u003cscript src=\"https://cdn.rawgit.com/Planeshifter/qality.js/d02a37d884cd658448ee64a058cd32ceb7df4dfb/dist/QAreader.min.js\"\u003e\u003c/script\u003e\n      \u003clink href=\"https://cdn.rawgit.com/Planeshifter/qality.js/d02a37d884cd658448ee64a058cd32ceb7df4dfb/css/exam.css\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\"/\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003cscript\u003e\n        new QAlity({\"sequence\":{\"nodes\":[{\"id\":0,\"type\":\"input\",\"question\":\"Who is the current president of the United States?\",\"right_answer\":\"Barack Obama\",\"transition_in\":\"dynamic\",\"transition_out\":\"dynamic\",\"points\":1,\"duration\":\"0\",\"background\":\"none\"}]},\"evaluation\":{\"seperator\":[{\"start\":0.33,\"id\":0},{\"start\":0.66,\"id\":1}],\"sorted\":[],\"ranges\":[{\"id\":0,\"text\":\"RANGE 1\",\"start\":0,\"end\":0.33},{\"id\":1,\"text\":\"RANGE 2\",\"start\":0.33,\"end\":0.66},{\"id\":2,\"text\":\"RANGE 3\",\"start\":0.66,\"end\":1}]}},\n        {\"div\":\"quizHolder\"});\n    \u003c/script\u003e\n    \u003cdiv id = \"quizHolder\"\u003e\u003c/div\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\nTo render your own quiz, replace the first argument passed to the `QAlity` function.  \n\n#### npm\n\n```bash\nnpm install qality\n```\n\nUse [browserify](https://github.com/substack/node-browserify) and render a quiz with only a few lines:\n\n```javascript\nvar QAlity = require( 'qality' );\n\nnew QAlity(\u003cqa object\u003e, {\n  \"div\":\"\u003cdiv to render to\u003e\"\n}, \u003coptional callback\u003e);\n```\n\n#### bower\n\n```\nbower install qality\n```\n\nRequire the necessary files in your `index.html` document:\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003c!-- Load QA Reader, which exposes constructor function QAlity to the window object --\u003e\n    \u003cscript src=\"bower_components/qality/dist/QAreader.min.js\"\u003e\u003c/script\u003e\n    \u003c!-- Load the standard CSS or provide your own --\u003e\n    \u003clink href=\"bower_components/qality/css/exam.css\" media=\"screen\"\n      rel=\"stylesheet\" type=\"text/css\"/\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003c!-- your code comes here --\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n## Usage:\n\n### Running the Editor\n\nA hosted version of the editor is accessible under the following link: [QAlity Frontend](http://qality.philipp-burckhardt.com/).\n\n\u003cimg src=\"http://burckhardt.ludicmedia.de/Quiz01.png\"\u003e\n\nTo run your own version, clone this repository and run\n\n```bash\nmake build\n```\n\nto compile the JavaScript necessary for running the frontend. The command\n\n```bash\nmake server\n```\n\nstarts a server at port 8000 and should automatically open the frontend in a browser.\n\n### API\n\n## Tests:\n\nRun tests via the command `npm test`\n\n---\n### License\n\n[MIT](http://opensource.org/licenses/MIT)\n\n### Icon Credits\n\n- \"Wrench\" by Calvin Goodman\n- \"Network\" by José Campos\n- \"Survey\" by Ann Fandrey\n- \"Close\" by Mateo Zlatar\n- \"Play\" by Mike Rowe\n- \"Add\" by Vittorio Maria Vecchi\n- \"Upload\" by Thomas Le Bas\n- \"Text\" by Zyad Basheer\n- \"Survey\" by Icons8\n- \"Marker\" by Anton Gajdosik\n- \"Box\" by Arthur Schmitt\n\n[npm-image]: https://badge.fury.io/js/qality.svg\n[npm-url]: http://badge.fury.io/js/qality\n\n[bower-image]:  https://img.shields.io/bower/v/qality.svg\n[bower-url]: https://github.com/Planeshifter/qality.js.git\n\n[travis-image]: https://travis-ci.org/Planeshifter/qality.js.svg\n[travis-url]: https://travis-ci.org/Planeshifter/qality.js\n\n[dependencies-image]: http://img.shields.io/david/Planeshifter/qality.js.svg\n[dependencies-url]: https://david-dm.org/Planeshifter/qality.js\n\n### Copyright\n\nCopyright \u0026copy; 2015. Philipp Burckhardt.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaneshifter%2Fqality.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplaneshifter%2Fqality.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaneshifter%2Fqality.js/lists"}