partymix

PartyMix: 🎈 PartyKit ⤫ Remix 💿

This is a remix.run adapter to deploy applications to PartyKit servers.

Get started

You can create a new PartyMix app with the following command:

npx create-remix@latest ./my-remix-app --template partykit/remix-starter

That's it! Alternately, you can add PartyMix to an existing Remix app with the following steps:

Usage

First, install the dependencies:

npm install partykit partymix

Define your PartyKit server like so:

// src/server.js

import { createRequestHandler } from "partymix";
import * as build from "@remix-run/dev/server-build";

const handleRequest = createRequestHandler({ build });

export default class MyRemix {
  static onFetch(request, lobby, ctx) {
    return handleRequest(request, lobby, ctx);
  }
}

And your partykit.json like so:

// partykit.json
{
  "name": "partymix",
  "main": "build/server.js", // point to the built version of your server
  "serve": "public"
}

And your remix.config.js like so:

// remix.config.js
/** @type {import('@remix-run/dev').AppConfig} */
export default {
  ignoredRouteFiles: ["**/.*"],
  server: "./src/server.js",
  serverConditions: ["partykit", "workerd", "worker", "browser"],
  serverMainFields: ["browser", "module", "main"],
  serverModuleFormat: "esm",
  serverPlatform: "neutral"
  // ...
};

You can then run your app locally:

npx remix dev --manual -c "npx partykit dev"

And then deploy the whole thing with:

npx remix build && npx partykit deploy

Thanks

(This adapter based on the original template for Cloudflare Workers)