https://github.com/automerge/automerge-classic

A JSON-like data structure (a CRDT) that can be modified concurrently by different users, and merged again automatically.
https://github.com/automerge/automerge-classic

crdt javascript offline-first

Last synced: 4 days ago
JSON representation

A JSON-like data structure (a CRDT) that can be modified concurrently by different users, and merged again automatically.

• Host: GitHub
• URL: https://github.com/automerge/automerge-classic
• Owner: automerge
• License: mit
• Created: 2017-04-19T15:25:24.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-03-14T15:24:45.000Z (almost 2 years ago)
• Last Synced: 2024-12-31T14:02:34.877Z (11 days ago)
• Topics: crdt, javascript, offline-first
• Language: JavaScript
• Homepage: http://automerge.org/
• Size: 3.86 MB
• Stars: 14,739
• Watchers: 200
• Forks: 464
• Open Issues: 78
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-repos - automerge/automerge-classic - A JSON-like data structure (a CRDT) that can be modified concurrently by different users, and merged again automatically. (JavaScript)
• awesome-repositories - automerge/automerge-classic - A JSON-like data structure (a CRDT) that can be modified concurrently by different users, and merged again automatically. (JavaScript)
• stars - automerge/automerge-classic - A JSON-like data structure (a CRDT) that can be modified concurrently by different users, and merged again automatically. (JavaScript)
• awesome-starred - automerge/automerge-classic - A JSON-like data structure (a CRDT) that can be modified concurrently by different users, and merged again automatically. (javascript)

README

        


## Deprecation Notice

Automerge now has a shiny new implementation at https://github.com/automerge/automerge. This repository is the original pure javascript implementation. All development effort has shifted to the new implementation which is written in Rust and so can easily be ported to other platforms. 

## Original Readme

💬 [Join the Automerge Slack community](https://join.slack.com/t/automerge/shared_invite/zt-e4p3760n-kKh7r3KRH1YwwNfiZM8ktw)

[![Build Status](https://github.com/automerge/automerge/actions/workflows/automerge-ci.yml/badge.svg)](https://github.com/automerge/automerge/actions/workflows/automerge-ci.yml)

[![Browser Test Status](https://app.saucelabs.com/buildstatus/automerge)](https://app.saucelabs.com/open_sauce/user/automerge/builds)

Automerge is a library of data structures for building collaborative applications in JavaScript.

Please see [automerge.org](http://automerge.org/) for documentation.

For a set of extensible examples in TypeScript, see [automerge-repo](https://github.com/automerge/automerge-repo)

## Setup

If you're using npm, `npm install automerge`. If you're using yarn, `yarn add automerge`. Then you

can import it with `require('automerge')` as in [the example below](#usage) (or

`import * as Automerge from 'automerge'` if using ES2015 or TypeScript).

Otherwise, clone this repository, and then you can use the following commands:

- `yarn install` — installs dependencies.

- `yarn test` — runs the test suite in Node.

- `yarn run browsertest` — runs the test suite in web browsers.

- `yarn build` — creates a bundled JS file `dist/automerge.js` for web browsers. It includes the

  dependencies and is set up so that you can load through a script tag.

## Meta

Copyright 2017–2021, the Automerge contributors. Released under the terms of the

MIT license (see `LICENSE`).