Skip to content

Project · library

syn

a toolkit for real-time shared appsGeneralized Holochain DNA and UI library for building real-time shared state hApps
How you run it
not recorded
Holochain version
0.7.1
Activity
active
Checked
29 October 2026

What is syn and what is it for?

syn is a software library for building Holochain apps in which several people work on the same document at once and each person's changes appear for the others as they are made. It supplies the shared-state engine and ready-made interface pieces, leaving the app developer to describe the shape of their document and how to draw it.

syn is a library for developers building Holochain apps that need live, shared state — the kind of software where two or more people work on the same document at the same time. It ships as a small set of JavaScript packages that can be added to a Holochain app: a client that talks to the app's backend, a store that handles documents, workspaces and sessions, and interface elements for common collaborative tasks such as editing text.

The shared document is treated as mergeable data, so changes from different people combine without a central server settling them. Participants pass their edits directly to one another over Holochain's peer-to-peer signals as they type, and the collected state is committed to the distributed hash table at intervals, which is what gives the document durability and data integrity.

The repository includes a sample application, SynText, that demonstrates collaborative text editing, along with a development setup that runs several participants at once so the synchronisation can be seen happening. The project's documentation site covers the design and how to use the packages.

How to get it

As a library

  1. Add the packages to a Holochain app from npm, for example: npm install @holochain-syn/store @holochain-syn/client
  2. To work on the DNA and the sample UI, the readme documents a nix-based setup: clone the repository, enter the dev shell with 'nix develop', run 'npm install', build with 'npm run build:happ', and run the sample UI with 'npm run start'.

Source: https://github.com/holochain-apps/syn

Questions people ask

How do I add syn to an app?
Install the packages from npm — for example 'npm install @holochain-syn/store @holochain-syn/client'. The repository readme lists all four packages and what each one provides. source
What does an app developer have to write?
According to the project's readme, three things: a shape for the document's state as a plain JavaScript object, a renderer for it, and the user interactions that change it. source
Where is syn documented?
The documentation site is built from the repository's docs directory and published at holochain-apps.github.io/syn. source

From 2 public sources, checked 23 September 2026.

Try syn

Details & sources

Evidence

Last change
api.github.com/repos/holochain-apps/synlisted by a third party · seen since 20 October 2026 · github.repository@1
Activity
api.github.com/repos/holochain-apps/synlisted by a third party · seen since 20 October 2026 · liveness@1

Compatibility

holochain-client
—
happ.yaml
present · workdir/happ.yaml @ 70c9699
web-happ.yaml
absent
Do you maintain syn?Add your name to this project’s page.
Claim this page