README.md

NOTE TO SPONSORS:

Hello! You're probably seeing this because you're sponsoring my work, and qualify to be in this repo! It's still a bit early; we don't have furniture, the wifi guy is coming next month, that sort of thing. But.. it sorta works already. If you're qualified for the platform, you can even deploy your servers!

I've also setup a discord! (i.e., I made a discord, and added a logo.) You can find me there and if I'm near a laptop I'll be happy to help you with setting anything up, or even just talking you through the whole thing; setting up, running it, deploying it, whatever. Here, come join me: https://discord.gg/Qp2JBYQs

Ok, back to the actual README.

partykit

Everything's better with friends.

partykit is a software development kit for building realtime collaborative applications. You can use it with your existing web applications, or build new ones from scratch.

You can create a server with very little code:

// server.ts

export default {
  onConnect(websocket, room) {
    // called whenever a user join a room
    websocket.send("hello from room: " + room.id);
  },
};

Then run npx partykit server.ts to start the server for local development. You can later deploy it to the cloud with npx partykit publish server.ts --name my-party.

Then, in your application, you can connect to this server with a simple client:

// PartySocket is a small abstraction over
// WebSocket that adds reconnection logic, etc.
import PartySocket from "partysocket";

const socket = new PartySocket({
  // for local development
  host: "localhost:1999",
  // for production
  // host: "my-party.username.partykit.dev",
  room: "my-room",
});

socket.on("message", (message) => {
  console.log(message); // "hello from room: my-room"
});

This way, you can add realtime collaboration to your existing web application with very little code. It runs alongside your existing application, and you can use it to build realtime features like collaborative text editors, multiplayer games, and more.

y-partykit

Yjs is a library of data structures for building collaborative applications. y-partykit is a library that makes it easy to host backends for Yjs on partykit. You can create a yjs backend with as little code as this:

// server.ts
import { onConnect } from "y-partykit";

export default { onConnect };

Then, you can use the provider to connect to this server:

import YPartyKitProvider from "y-partykit/provider";

const provider = new YPartyKitProvider("localhost:1999", "my-room", doc);

Have a look at the official documentation, their examples should just work with y-partykit (replacing y-websocket with y-partykit/provider like above)

party.io

(NB: THIS DOES NOT EXIST YET)

party.io is a library heavily influenced by socket.io. It's an abstraction over partysocket that makes it easy to build realtime applications. You might use it on the client:

import Party from "party.io";

const io = new Party({
  // for local development
  host: "localhost:1999",
  // for production
  // host: "my-party.username.partykit.dev",
});

const socket = io.join("my-room");

socket.emit("hello", "world"); // named events

socket.emit("hello", { nested: { object: "world" } }, ["some", "array"]); // nested objects and arrays

socket.emit("hello", [1, 2, 3], (...args) => {
  // callbacks
});

socket.on("hello", (arg1, arg2, callback) => {
  // subscribe to events
});

And on the server:

import { onConnect } from "party.io";

export default {
  onConnect(ws, room) {
    onConnect(ws, room, (socket) => {
      socket.on("hello", (arg1, arg2, callback) => {
        // subscribe to events
      });

      socket.emit("hello", "world"); // named events
      // ...and so on
    });
  },
};