aerogear-attic / aerogear-nodejs-sync-server Goto Github PK

This project in an implementation of Google's Differential Synchonrization by Neil Fraser, that can be used by AeroGear's client libraries.

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 required to be done once before building the first time, or if the dependencies in package.json have been updated.

$ npm start

For more details about the current release, please consult our documentation.

• Differential Synchronization presentation
• Differential Synchronization paper
• Differential Synchronization step by step keynote presentation

$ npm test

To run a single test you can use:

$ node test/sync-engine-test.js | node_modules/tap-spec/bin/cmd.js

If you are using Node 7.x you can use the --inspect --debug-brk command line options to debug code, for example:

$ node --inspect --debug-brk test/sync-engine-test.js | node_modules/tap-spec/bin/cmd.js
Debugger listening on port 9229.
Warning: This is an experimental feature and could change at any time.
To start debugging, open the following URL in Chrome:
chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=localhost:9229/9840e0cc-0603-47e1-a817-14989ab71f57

On previous version of Node, use devtool: devtool test/sync-engine-test.js

Logging can be enable by setting the NODE_DEBUG environment variable to the name of the JavaScript source file you want to enable logging for. For example:

$ env NODE_DEBUG=sync-engine node index.js

$ npm run lint

To automatically fix issues you can use:

$ $ npm run lint -- --fix

Multiple JavaScript files can be added if you are interested in more than one by comma separating them.

If you would like to help develop AeroGear you can join our developer's mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.

Also takes some time and skim the contributor guide

Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!

If you found a bug please create a ticket for us on Jira with some steps to reproduce it.