This README would document whatever steps are necessary to get the DomoscioJS SDK up and running.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

DomoscioJS requires the jQuery Javascript library. Make sure to load jquery.js file before loading DomoscioJS.

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>

Place the following script tag near the end of your pages, right before the closing tag, to enable them. jQuery must come first, then DomoscioJS, and then your script.

<script src="https://rawgit.com/Celumproject/domoscio_js/master/v1/domosciojs.min.js"></script>

Then you have to configure the DomoscioJS object like bellow with your credentials to access your enabled APIs. Refer to the API documentation for details: https://domoscio.com/wiki/doku.php?id=api2:start

DomoscioJS.configuration = { 
    preproduction: true,
    version: API_VERSION,
    client_id: YOUR_INSTANCE_ID,
    client_passphrase: "YOUR_ACCESS_TOKEN"
}

Simple yet flexible JavaScript request for Domoscio API.

Fetch all object corresponding with the parameters :

DomoscioJS.Student.fetch({uid: "Example"})

Find the object corresponding with the id :

DomoscioJS.Student.find({id: "Example"})

Create an object :

DomoscioJS.Student.create({uid: "Example", active: true})

Some utils routes :

DomoscioJS.GameplayUtil.util("get_review_progress", { student_id: id, knowledge_node_id: id })

To deploy this on a live system, use the script tag bellow :

<script src="https://cdn.rawgit.com/Celumproject/domoscio_js/160e555c/v1/domosciojs.min.js"></script>

Currently v1.0.3

See the list of contributors (https://github.com/Celumproject/domoscio_js/contributors)