feathers-automerge

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #golang #go #android #machine-learning #rust #linux #docker #cli #vue #pytorch #ios

feathers-automerge

(★ 17)

Feathers Offline Synchronization

feathers-automerge Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Feathers Offline Synchronization

Packages for integrating Feathers API and client applications with [Automerge](https://automerge.org/) for offline capabilities and server to server synchronization:

- `@kalisio/feathers-automerge`: A service implementation on top of the Automerge CRDT as well as a client for offline synchronization with a `feathers-automerge-server`. Read the full documentation [here](packages/feathers-automerge/README.md).
- `@kalisio/feathers-automerge-server`: Integrates an Automerge sync server into an existing Feathers server and synchronizes offline documents with clients and other servers. Read the full documentation [here](packages/feathers-automerge-server/README.md).

## Example

This repository contains an example for a Feathers API with full offline-first capabilities. It comes in several components:

### Installation

Install all the dependencies in the monorepo with

```sh
git clone git@github.com:kalisio/feathers-automerge.git
cd feathers-automerge
yarn install
```

### Running the example

With Docker running, the development system can be started like this

```sh
yarn run dev
```

Then go to [http://localhost:5173](http://localhost:5173). The API server is running at [http://localhost:3030](http://localhost:3030).

To run another server to test server to server synchronization in a new terminal run:

```sh
yarn run s2s
```

It will be available at [http://localhost:5050](http://localhost:5050).

## Goal

The goal of this project is to add full offline-first capabilities to a Feathers API.

## Automerge Snapshots

In order to flexibly add offline capabilities we are proposing the following structure:

## Alternatives

Several local-first synchronization options were evaluated, however, most rely on (Postgre)SQL or paid infrastructure.

## Limitations

- Soft delete
- Run hooks (keep separate snapshot of server "view" and client changes)

feathers-automerge

feathers-automerge Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

feathers-automerge

feathers-automerge Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README