agevole / leaps Goto Github PK

Leaps is a service for hosting collaboratively edited documents using operational transforms to ensure zero-collision synchronization across any number of editing clients.

To read more and find examples check out the wiki: leaps wiki

##How to run

Leaps is a single binary, with no runtime dependencies, everything is set through a single config file. Just download a release package for your OS and do the following to set up an example:

tar -xvf ./leaps-linux_amd64-v0.1.2.tar.gz
cd leaps
./leaps -c ./config/leaps_example.yaml

and then visit: http://localhost:8080 to play with an example server. A leaps service by default will run and host a statistics page to view event counts and uptime, for the example this is hosted at: http://localhost:4040.

To generate a configuration file of all default values:

# for a JSON file
./leaps --print-json

# for a YAML file
./leaps --print-yaml

##Customizing your service

To learn how to customize your leaps service read here: leaps service wiki

##Leaps clients

The leaps client is written in JavaScript and is ready to simply drop into your website. You can read about it here: leaps client wiki

The files to include can be found in the release packages at ./js, or in a built repository at ./bin/js. Here's a short example of using leaps to turn a textarea into a shared leaps editor:

window.onload = function() {
	var client = new leap_client();
	client.bind_textarea(document.getElementById("document"));

	client.on("connect", function() {
		client.join_document("test_document");
	});

	client.connect("ws://" + window.location.host + "/socket");
};

Then at some point you might want to close it:

client.close();

##System compatibility

##How to build

Dependencies:

• Golang 1.2+
• golint

To build clients:

• nodejs
• npm (uglifyjs, jshint, nodeunit)

To build and then start up an example server do the following:

go get github.com/jeffail/leaps
cd $GOPATH/src/github.com/jeffail/leaps

# To build the binary and client libraries:
make
./bin/leaps -c ./config/leaps_example.yaml

# Or, to build only the service binary:
go build

##Contributing and customizing

Contributions are very welcome, just fork and submit a pull request.

Godocs for the service library can be found here.

##Contact

Ashley Jeffs

• Web: http://jeffs.eu
• Twitter: @Jeffail
• Email: [email protected]