Google Git
Sign in
vanadium / release.js.syncbase / 35cde98b5658037f85daa8392351219356bca4f2
commit35cde98b5658037f85daa8392351219356bca4f2[log] [tgz]
authorTodd Wang <toddw@google.com>Fri Sep 11 17:49:09 2015 -0700
committerTodd Wang <toddw@google.com>Fri Sep 11 17:49:09 2015 -0700
tree1c38aab9d610253b533838a3bbdec62ea534f23b
parent60f681555dfa55f3e288cbdfe2c144a7c24a0048 [diff]
TBR: js.syncbase: Prepare all repos for open-sourcing.

The CONTRIBUTING file is added to all repos, and also added
to the jiri-copyright tool so that repos can be automatically
checked and fixed.

I've run jiri copyright fix against all repos to fix up
outstanding issues.

MultiPart: 9/23

Change-Id: Ie4f163d9ef963b1e646a06cecef9a9b536395aad
1 file changed
tree: 1c38aab9d610253b533838a3bbdec62ea534f23b
  1. jsdocs/
  2. src/
  3. test/
  4. .gitignore
  5. .jshintignore
  6. .jshintrc
  7. AUTHORS
  8. CONTRIBUTING
  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, sycnbase 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