Joola's Software Development Kit (SDK)
JavaScript CSS Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
src
test
.coveralls.yml
.gitignore
.jshintignore
.jshintrc
.npmignore
.travis.yml
AUTHORS.md
CONTRIBUTING.md
Gruntfile.js
LICENSE.md
Makefile
README.md
package.json

README.md

joola.sdk Build Status Gitter chat

Selenium Test Status

[API Docs] apidocs [joola Docs] techdocs Issues issues Contributing contributing About about
[![i2] roadmap-image] apidocs [![i1] techdocs-image] techdocs [![i6] issues-image] issues [![i4] contributing-image] contributing [![i5] about-image] about

joola logo

joola.sdk is a Software Development Kit (SDK) responsible for communication between a client using the SDK and the joola server. If you don't have a joola server running yet, get one up and running in minutes or open a free account with free.joola.

The SDK can consume ANY endpoint of the joola framework, however for brevity purposes, the API manual below includes only the main topics of:

  • Pushing data is done by sending an array of JSON documents for storage in joola cache.
  • When Querying, you describe the data you wish to consume and shape it to your liking.
  • Transform your data into insight using Data Visualization.

Getting the SDK

Option 1: Include joola.sdk in your HTML.

<script src="http://localhost:8080/joola.js"></script>
<script>
  console.log(joola.VERSION);
</script>

Optional: if you'll include ?APIToken=XXXXXX, you'll be able to use joola.sdk without calling init.

Option 2: Require the SDK require('joola.sdk');

$ npm install http://github.com/joola/joola.sdk/tarball/develop
var joola = require('joola.sdk');
console.log(joola.VERSION);

Quick Example

<!DOCTYPE html>
<html>
<head></head>
<body>

<div id="metric-visits"></div>

<script src="http://localhost:8080/joola.js?APIToken=12345"></script>
<script>
  joola.events.on('ready', function () {
    joola.beacon.insert('visits', {username: 'thisisme', visits: 1});
    new joola.viz.Metric({
      container: '#metric-visits',
      query: {
        timeframe: 'last_hour',
        interval: 'minute',
        dimensions: [],
        metrics: ['visits']
      }
    });
  });
</script>
</body>
</html>

Learn more about using the SDK

Contributing

We would love to get your help! We have outlined a simple Contribution Policy to support a transparent and easy merging of ideas, code, bug fixes and features.

If you're looking for a place to start, you can always go over the list of open issues, pick one and get started. If you're feeling lost or unsure, just let us know.

Contact

Contacting us is easy, ping us on one of these:

License

Copyright (c) 2012-2015 Joola Smart Solutions. GPLv3 Licensed, see LICENSE for details.