Binnacle JS

JS Client for Binnacle.io Distributed Event Logging and Multi-channel Push Service

.... /\_/\\\________________ /\________________________________________________________________________////\_ /\_____/\_/\__________________ /\_________///_/\/\\\/\/\\\_/\\\\_/\\\\/\_/\\\\ /\\\\___/\_/\////\_/\////\_////////\_/\///////\_/\/////\_ /\////\_/\_/\_//\_/\_//\_/\\\\\/\___________/\_/\\\\\_ /\_/\_/\_/\_/\_/\_/\_/\/////\_//\_/\_//\///////_ _/\\\\_/\__/\_/\_/\_/\_//\\\\/\///\\\\/\\\\_//\\\\\_ ///////////////////////////////////////////////////___////////// ....

Getting Started

In your web page:

<script src="../build/dist/binnacle.js"></script>
<script>
var client = new Binnacle.Client({
  accountId: accountId,
  appId: appId,
  apiKey: apiKey,
  apiSecret: apiSecret,
  endPoint: endPoint,
  contextId: contextId,
  onSignal: function(event) {
    // do something with the event
  }
});
client.subscribe();
</script>

Documentation

(Coming soon)

Examples

(Coming soon)

Release History

(Nothing yet)

Developer Setup

• Fork and clone the repo.

Install NPM packages

• Run npm install to install all dependencies (including Grunt).
• npm install -g bower
• npm install grunt-bower-task --save-dev
• npm install grunt-bower-concat --save-dev

Build

• grunt --help : List available grunt tasks
• grunt clean build : Clean and build the project

Test

• html/subscription_example.html : Simple example of subscribing to a Binnacle App/Context