DEPRECATED

This library is no longer being maintained. Please take a look at ShareJS for a reasonable alternative.

Tandem Realtime Coauthoring Engine

How to Use

Client

var tandem = new Tandem.Client('http://localhost:8008');
var file = tandem.open(fileId);
file.on('file-update', function(delta) {
    // ...
});
file.update(delta);

Server

var Tandem = require('tandem')

var server = require('http').Server();
new Tandem.Server(server);

Installation

NPM (Server)

Add to package.json

"dependencies"  : {
    "tandem": "0.12.x"
}

Testing

We use mocha as our testing framework. To run the unit tests, simply:

make test

To run our coverage tool:

make cov

Project Organization

Top level files/directories

The tandem source code is in the src folder. Tests are in the tests folder.

All other files/directories are just supporting npm, build, demo, or documentation files.

build - build output
demo - demos
doc - additional documentation
scripts - test coverage script
src - source code
tests - unit tests
browser.js - npm
client.coffee - enable node.js to require src/client, used by unit tests
Gruntfile.coffee - grunt configs
index.js - npm
Makefile - define make commands
package.json - npm

LICENSE

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

byronm/tandem