Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Javascript libraries for accessing CloudMine
JavaScript HTML CSS Ruby Other

README.md

CloudMine JavaScript SDK

CloudMine is a backend-as-a-service platform for mobile and web developers to rapidly build and quickly scale their apps. Build and scale iOS, Android, Windows Phone, and web apps on our secure and managed backend.

The JavaScript library supports both Node.js and browsers.

Install

via npm

$ npm install cloudmine

via git to get the bleeding edge

$ npm install git://github.com/cloudmine/cloudmine-js.git

directly link from a browser

<script type="text/javascript" src="https://raw.github.com/cloudmine/cloudmine-js/master/js/cloudmine.js"></script>

You may also rebuild and test the CloudMine JavaScript library by using the provided Cakefile.

Documentation

Detailed documentation, tutorials and code samples are on our developer site: https://cloudmine.me/docs/js.

Direct link to API reference documentation: https://cloudmine.me/js-docs/symbols/WebService.html.

Also check out the examples included with the repository.

Quick Start

The main API class is cloudmine.WebService

In node:

var cloudmine = require('cloudmine');

var ws = new cloudmine.WebService({
    appid: 'your appid',
    apikey: 'your apikey'
});

ws.set("key", {"hello": "world"});

In browsers:

<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script type="text/javascript" src="https://raw.github.com/cloudmine/cloudmine-js/master/js/cloudmine.js"></script>
<script>
  var ws = new cloudmine.WebService({
      appid: 'your appid',
      apikey: 'your apikey'
  });

  ws.set("key", {"hello": "world"});
</script>

Now check your CloudMine dashboard (https://cloudmine.me/dashboard/) to see your data saved.

License

This software is distributed under the MIT License. See the LICENSE file for details.

Compatibility

This library has been tested to work under the following environments:

  • Chrome 22, Stable
  • Firefox 15, Stable
  • Firefox 3.6
  • Safari 5
  • Internet Explorer 10

Known Issues

  • Firefox 3.6 will not trigger specific error events (notfound, unauthorized) for invalid application or api key specification.
  • Internet Explorer 10 changes location of entire page while downloading files when running locally.
Something went wrong with that request. Please try again.