Iris Docs

Iris Docs is a proof-of-concept collaborative tool featuring docs, canvas and an explorer for the underlying IrisDB data structure.

Accounts are public keys: you can create them at will, and no one can take away your account. Your data is synced over Nostr relays and also stored locally in your browser.

Users can freely choose whose edits to a document they want to see. For example, editors can be a list of users curated by the document's creator, or it could be everyone you follow on Nostr. You can always fork someone else's document and change the list of editors you want to see.

This is especially useful in use cases like wikis, where all users might not trust the same authors. It avoids the centralization of power to a handful of moderators, and ultimately the owner of some domain name.

The underlying IrisDB can be used to easily create all kinds of decentralized applications. https://github.com/irislib/irisdb

For text document sync, we use https://github.com/yjs/yjs

Deployed on docs.iris.to

Development

npm

npm install
npm run dev

docker-compose

docker-compose up

Codespace

create-iris

Create your own IrisDB or Nostr application? This project can be used as a template with npm create iris@latest.

It has basic building blocks like app routing, navigation, authentication, network settings, social networking and IrisDB usage examples.

npm create iris@latest

Stack

• Vite - Build and development environment
• React
• IrisDB
• Tailwind
• DaisyUI
• NDK for syncing data over Nostr
• yjs for collaborative text documents
• TipTap for collaborative rich text documents
• Remix Icon for icons