yavuzsel / aerogear-js

JavaScript client library implementation for AeroGear

aerogear-js

JavaScript client library implementation for AeroGear. Eventually, this will include API's for persistence, security, data synchronization and more. For more information and downloads, visit AeroGear.org.

Auth

---

The AeroGear.Auth namespace provides an authentication and enrollment API. Through the use of adapters, this library provides common methods like enroll, login and logout that will just work.

See the Auth API docs for more info.

DataManager

---

A collection of data connections (stores) and their corresponding data models. This object provides a standard way to interact with client side data no matter the data format or storage mechanism used.

See the DataManager API docs for more info.

Notifier

---

Notifier is a collection of adapters which provide a unified or similar API for interacting with different messaging services and protocols.

See the Notifier API docs for more info.

Pipeline

---

Pipeline is a JavaScript library that provides a persistence API that is protocol agnostic and does not depend on any certain data model. Through the use of adapters, both provided and custom, user supplied, this library provides common methods like read, save and delete that will just work.

See the Pipeline API docs for more info.

Library Dependencies

---

Some parts of AeroGear.js depend on external libraries which are not bundled in the same file. Below is a list of each plugin and their adapters along with dependencies, if they have any.

Auth

• REST
  • jQuery

DataManager

• Memory
  • jQuery
• SessionLocal
  • jQuery

Notifier

• STOMP-WS
  • STOMP Over WebSocket
• vert.x
  • vert.x Event Bus
  • SockJS

Pipeline

• REST
  • jQuery

Building

---

Grunt

Grunt is used as the build tool which requires Node.js version >= 0.8.0. Please refer to nodejs.org for details regarding installing Node.js. Please refer to Grunt's getting started guide for details regarding installing Grunt.

Installing Build Dependencies

To install the dependencies of the project run the following command:

$ npm install

This will install the versions of the dependencies declared in package.json. This is only requried to be done once before building the first time, or if the dependencies in package.json have been updated.

Building the project

$ grunt

The produced JavaScript will be in the dist directory.