Git Product home page Git Product logo

collaborativejs / collaborative-js Goto Github PK

View Code? Open in Web Editor NEW
12.0 4.0 2.0 13.43 MB

Operational transformation library to build applications and web-services with collaborative access to the data (live data editing).

Home Page: http://collaborativejs.org

License: MIT License

JavaScript 100.00%
collaborative-software shared-access groupware live-editing rich-text plain-text undo redo operations-history offline-operations

collaborative-js's Introduction

Collaborative.js - Collaborative software for any project

npm version CircleCI github issues

Collaborative.js is a JavaScript library to build applications and web-services with collaborative access to the data (live data editing).

Our mission is to completely solve the issue of implementing collaborative access to the data for all kind of web services and applications. We examine this topic in a comprehensive manner, scrupulously gathering use cases and feedback to provide a consistent solution for all popular programming languages and platforms. This repository is about JavaScript.

Download

Using Package Mangers

You can install Collaborative.js using any of popular package managers.

npm Bower Yarn
npm install collaborative bower install collaborative yarn add collaborative

Using CDN

Collaborative.js is available as a ready-to-include CDN resource.

  • jsDeliver CDN - https://cdn.jsdelivr.net/npm/collaborative/dist/collaborative.min.js
  • unpkg CDN - https://unpkg.com/collaborative/dist/collaborative.min.js

Direct Download

All Collaborative.js binary files can be found in dist directory of the master github branch or collaborative-js.zip archive.

Getting Started

Getting Started guide leads through the most basic tasks of the collaborative access topic. During this guide we will build a simple Node.js application with collaborative access to a plain text (text live editing).

Note: If you prefere to run getting started example first, visit getting-started-example repo

Features

Arbitrary JSON

Complete set of operations (CRUD) allows to building applications of any complexity.

Plain Text

An exhaustive set of functionality to implement collaborative access to text documents.

Cursor Management

The position of the cursor during the string or JSON operation is completely under control.

Undo/Redo operations

Undo/Redo operations are supported out of the box, you don't need to implement complex algorithms to get them work.

Operations History

The Collaborative.js engine supports Operations History on a native level, all you need is to build good looking UI based on our API.

Offline Operations

Offline Operations feature allows you to build an application or web-service that is able to work in offline mode, with no stable network connection.

WebSocket and AJAX

There are no network protocol restrictions, Collaborative.js supports with both WebSocket and AJAX protocols.

Legacy Browsers Support

All major browsers including legacy versions e.g IE 6 are supported.

Demo

Rich Text Editor Demo JSON Structure Demo
Rich Text demo with collaborative access (text live editing) | Collaborative.js JSON structure demo with collaborative access (data live editing) | Collaborative.js
View Source Coming soon...

Further Learning

License

© Collaborativejs.org - Operational transformation library, released under the MIT License.

collaborative-js's People

Contributors

grasshoppergn avatar romanlubushkin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

fstfwd

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.