QAlity.js
Multiple-Choice QA System for JavaScript
Features:
- Versatile: Several question types: multiple choice, input fields, timed and untimed questions
- Evaluation system: Provide result scores and targeted feedback
- Animations: customizable animations based on the performant gsap library
- Visual Editor: create quizzes interactively using a visual frontend
- Markdown support: implemented via markdown-it
- Math support: blazingly fast rendering via KaTeX
- Customizable Design: change appearance of all elements via CSS
Getting Started
Create a quiz on on the QAlity Frontend, grab the created JavaScript object and insert on your page via one of the following options.
Installation:
CDN
Include the following two lines in your head
and you are ready to go:
See the following minimal working example:
To render your own quiz, replace the first argument passed to the QAlity
function.
npm
npm install qality
Use browserify and render a quiz with only a few lines:
var QAlity = ; <qa object> "div":"<div to render to>" <optional callback>;
bower
bower install qality
Require the necessary files in your index.html
document:
<!-- Load QA Reader, which exposes constructor function QAlity to the window object --> <!-- Load the standard CSS or provide your own --> <!-- your code comes here -->
Usage:
Running the Editor
A hosted version of the editor is accessible under the following link: QAlity Frontend.
To run your own version, clone this repository and run
make build
to compile the JavaScript necessary for running the frontend. The command
make server
starts a server at port 8000 and should automatically open the frontend in a browser.
API
Tests:
Run tests via the command npm test
License
Icon Credits
- "Wrench" by Calvin Goodman
- "Network" by José Campos
- "Survey" by Ann Fandrey
- "Close" by Mateo Zlatar
- "Play" by Mike Rowe
- "Add" by Vittorio Maria Vecchi
- "Upload" by Thomas Le Bas
- "Text" by Zyad Basheer
- "Survey" by Icons8
- "Marker" by Anton Gajdosik
- "Box" by Arthur Schmitt
Copyright
Copyright © 2015. Philipp Burckhardt.