Disclaimer: This package is currently in preview and may have breaking changes between versions. Please wait for a v1.0.0 stable release before using this in production.

Pluv.IO (preview)

Multi-platform, E2E type-safe realtime packages

💕 Inspired by trpc 💕 yjs 💕 and Cloudflare 💕

Intro • Usage • Related • Credits • License

Intro

pluv.io allows you to more easily build real-time collaborative experiences with a fully end-to-end type-safe api and the ecosystem of existing CRDT implementations such as yjs.

👉 See full documentation on pluv.io. 👈

Features

✅ Automatic type safety
✅ Basic events
✅ Rooms
✅ Authentication
✅ Awareness + Presence
✅ CRDTs
- ✅ Yjs
  - ✅ Shared Types
    - ✅ Map
    - ✅ Array
    - ✅ Text
    - ✅ XmlFragment
    - ✅ XmlElement
    - ✅ XmlText
- ✅ Loro
  - ✅ Containers
    - ✅ List
    - ✅ Map
    - ✅ Text
    - ⬜ Tree
⬜ Studio (admin & developer panel)

Runtimes

✅ Cloudflare Workers
✅ Node.js
- ✅ PubSubs
  - ✅ Redis
  - ⬜ RabbitMQ
  - ⬜ Kafka
- ✅ CRDT State Persistence
  - ✅ Redis
  - ⬜ Prisma

Frontends

✅ React.js
⬜ Solid.js
⬜ Vue.js
⬜ Svelte

Usage

Before diving into documentation, check out usage instructions for your selected platform:

Documentation

Documentation is available at pluv.io.

@pluv/client - Framework agnostic client
@pluv/crdt-loro - Loro CRDT for Pluv.IO
@pluv/crdt-yjs - Yjs CRDT for Pluv.IO
@pluv/persistence-redis - Persistence for storage on distributed systems (Node.js only)
@pluv/platform-cloudflare - Adapter to run @pluv/io on Cloudflare Workers
@pluv/platform-node - Adapter to run @pluv/io on Node.js
@pluv/pubsub-redis - PubSub for rooms across distributed systems
@pluv/react - Integrate @pluv/client with React.js

Credits

This software uses the following open source tooling and libraries:

License

MIT

pluv-io/pluv