Overview

This project aims to implement a Learning Record Store based on the specifications of the RESTful Experience API (API Spec) in node.js.

Documentation is generated using Codo. The current Docs can be found here.

A report viewer is beeing developed as part of this implementation.

Deployment

edit app/config.coffee to match your couchDB server
install node, see package.json for required version
install all global dependencies or add the projects node_modules/.bin to your PATH. Currently the global dependencies are:
- grunt-cli
- coffee-script
run npm install to install all dependencies locally
hit grunt to launch the application
grunt mochaTest for running all test cases
grunt doc to generate the latest docs locally in the doc folder