Google Git
Sign in
vanadium / release.js.syncbase / 8aa834b13a68974fe230af0fe4866246224b0652
commit8aa834b13a68974fe230af0fe4866246224b0652[log] [tgz]
authorAdam Sadovsky <asadovsky@gmail.com>Mon Oct 05 12:57:26 2015 -0700
committerAdam Sadovsky <asadovsky@gmail.com>Mon Oct 05 13:00:42 2015 -0700
tree866d24e173001bd787dfbae49400917ac4b3aba2
parentb5aaa50cc066a733e3a89e91f8caea24db43333f [diff]
TBR: js.syncbase: switch to CONTRIBUTING.md

Change-Id: Ibbb8cc4431d67c0421979f38e7da5992ae0b4134
MultiPart: 10/24
2 files changed
tree: 866d24e173001bd787dfbae49400917ac4b3aba2
  1. jsdocs/
  2. src/
  3. test/
  4. .gitignore
  5. .jshintignore
  6. .jshintrc
  7. AUTHORS
  8. CONTRIBUTING.md
  9. CONTRIBUTORS
  10. LICENSE
  11. Makefile
  12. package.json
  13. PATENTS
  14. README.md
  15. VERSION
README.md

Syncbase JavaScript Client

This repository defines the JavaScript API for Syncbase, a structured store that supports peer-to-peer synchronization.

The client APIs defined here work both in Node.js and the browser.

Install

Since Vanadium is currently hosted in private repositories, you would need to [setup SSH keys for Github] (https://help.github.com/articles/generating-ssh-keys/) first and then use npm to install directly from GitHub:

npm install --save git+ssh://git@github.com:vanadium/js.syncbase.git

currently vanadium.js needs to be installed manually as well:

npm install --save git+ssh://git@github.com:vanadium/js.git

Usage

Documentation for this API is [TODO(aghassemi)](LINK TO JS DOCUMENTATION)

Tutorials can be found at [TODO(aghassemi)](LINK TO JS TUTORIAL FOR SYNCBASE)

The entry point to the API is through a module called syncbase, everything else is considered private and should not be accessed by the users of the API.

When using Browserify or Node.js users can gain access to the API with:

var syncbase = require("syncbase");

When run in a browser, syncbase expects that the vanadium extension will be installed.

Bugs and feature requests

Bugs and feature requests should be filed in the Vanadium issue tracker.

Building and testing

GNU Make is used to build and test Syncbase.

Build everything:

make

Test everything:

make test

Run a specific test suite:

make test-integration
make test-integration-node
make test-integration-browser

Remove all build and testing artifacts:

make clean