Giter Club home page Giter Club logo

cherry-edit's Introduction

Cherry Edit ๐Ÿ’

Description

Coding exercise implementing a collaborative text editor based on replicated growable arrays (RGA) [1]. An RGA is an ordered sequence conflict-free replicated data type (CRDT). The implementation is based on the explanations given on a conference talk about the work on nested CRDTs, specifically a conflict-free replicated JSON data type [2].

Usage

  1. Build the project using sbt stage. You can use sbt dist to generate a ZIP application bundle.
  2. Start the server. The log will show the server address, e.g. akka.tcp://[email protected]:2552
    server/target/universal/stage/bin/cherry-edit-server
    
  3. Start the client, passing the server address as a command line argument.
    client/target/universal/stage/bin/cherry-edit-client \
      akka.tcp://[email protected]:2552
    

Configuration

Please refer to the reference.conf files in the client and server modules for the available configuration options.

Known Issues

  • We can't deal with messages arriving out of order, yet
  • We are not retrying failed messages and might go out of sync

References

[1] Roh, H.G., Jeon, M., Kim, J.S. and Lee, J., 2011. Replicated abstract data types: Building blocks for collaborative applications. Journal of Parallel and Distributed Computing, 71(3), pp.354-368.

[2] Kleppmann, M. and Beresford, A.R., 2017. A conflict-free replicated JSON datatype. IEEE Transactions on Parallel and Distributed Systems, 28(10), pp.2733-2746.

cherry-edit's People

Contributors

frosner avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

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.