QLICKER

Documentation and User Manual

Qlicker Repo: https://github.com/etenoch/qlicker

JSDocs

All meteor methods and React components are documented using JSDoc. Generated JSDocs (HTML files) are stored in docs/.jsdocs You can view the HTML version hosted at: https://rawgit.com/etenoch/qlicker/master/docs/.jsdocs/index.html

To update the JSDocs

npm install jsdoc -g # install jsdoc
npm run doc

Documentation

All other documentation including user manuals are in the markdown files below.

Qlicker User Manual

• Student User Manual
• Professor User Manual
• Admin User Manual

Developing Qlicker

• Architecture Overview
• Database and Data Structure
• Development Guide
• Meteor Method API List

Deploying Qlicker

• Deploying Manually
• Docker Deployment