MCPcopy
hub / github.com/partykit/partykit

github.com/partykit/partykit @0.0.33 sqlite

repository ↗ · DeepWiki ↗ · release 0.0.33 ↗
1,095 symbols 2,995 edges 213 files 189 documented · 17%
README

image

npm beta Discord License

PartyKit simplifies developing multiplayer applications.

With PartyKit, you can focus on building multiplayer apps or adding real-time experiences to your existing projects with as little as one line of code. Meanwhile, PartyKit will handle operational complexity and real-time infrastructure scaling.

Documentation

Go to docs.partykit.io for documentation, guides and examples.

Quick start

Note: to run PartyKit, you need to have Node v. 17 or higher installed.

You can create a PartyKit project by running:

npm create partykit@latest

This will ask a few questions about your project and create a new directory with a PartyKit application, that includes a server and a client.

Alternatively, you can add PartyKit to your existing project using the following command in the project's root directory:

npx partykit@latest init

From inside the directory, you can then run npm run dev to start the development server. When you're ready, you can deploy your application on to the PartyKit cloud with npm run deploy.

Developers

Community and support

  • GitHub issues to report bugs 🐛
  • Discord to ask questions, share your ideas and feedback, and help us celebrate your PartyKit projects 💕
  • Twitter to say "hi" and get the freshest updates!

Contributing

We encourage contributions to PartyKit. If you're interested in contributing or need help or have questions, please join us in our Discord.

License

PartyKit is MIT licensed.

Extension points exported contracts — how you extend this code

TypedEventBroadcaster (Interface)
* Interface for classes that aren't `EventEmitter`s, but still expose a * strictly typed `emit` method. [6 implementers]
packages/party.io/src/socket.io/lib/broadcast-operator.ts
ConnectionManager (Interface)
(no doc) [4 implementers]
packages/partykit/facade/connection.ts
CallbackOptions (Interface)
(no doc)
packages/y-partykit/src/index.ts
PartyStorage (Interface)
(no doc)
packages/partymix/src/partyStorage.ts
Props (Interface)
(no doc)
apps/blog/src/components/Datetime.tsx
SocketDetails (Interface)
* Format of the data when the Socket instance exists on another Socket.IO server
packages/party.io/src/socket.io/lib/broadcast-operator.ts
PKCECodes (Interface)
* An implementation of rfc6749#section-4.1 and rfc7636.
packages/partykit/src/cf-auth/user.ts
HandlerCallbackOptions (Interface)
(no doc)
packages/y-partykit/src/index.ts

Core symbols most depended-on inside this repo

get
called by 121
packages/partymix/src/partyStorage.ts
getLogger
called by 94
packages/party.io/src/logger.ts
join
called by 94
packages/party.io/src/socket.io/lib/socket.ts
set
called by 93
packages/partykit/facade/connection.ts
fetch
called by 83
packages/partykit/facade/source.ts
send
called by 65
packages/party.io/src/engine.io/lib/socket.ts
emit
called by 64
packages/party.io/src/socket.io/lib/broadcast-operator.ts
parse
called by 56
packages/party.io/src/msgpack/lib/decode.ts

Shape

Function 514
Method 362
Class 153
Interface 63
Enum 3

Languages

TypeScript100%

Modules by API surface

packages/partykit/src/cf-auth/user.ts90 symbols
packages/partykit/facade/source.ts40 symbols
packages/party.io/src/socket.io/lib/adapter.ts40 symbols
packages/party.io/src/socket.io/lib/socket.ts39 symbols
packages/partykit/facade/connection.ts34 symbols
packages/partykit/src/dev.tsx33 symbols
packages/y-partykit/src/storage.ts30 symbols
packages/party.io/src/socket.io/lib/server.ts25 symbols
packages/party.io/src/socket.io/lib/broadcast-operator.ts25 symbols
packages/y-partykit/src/index.ts22 symbols
packages/partykit/src/inspect.ts22 symbols
packages/partykit/facade/worker.ts22 symbols

Dependencies from manifests, versioned

@astrojs/check0.5.2 · 1×
@astrojs/mdx2.1.1 · 1×
@astrojs/partytown2.0.4 · 1×
@astrojs/react3.0.10 · 1×
@astrojs/rss4.0.5 · 1×
@astrojs/sitemap3.0.5 · 1×
@astrojs/starlight0.17.4 · 1×
@astrojs/tailwind5.1.0 · 1×
@astrojs/vercel7.3.0 · 1×
@blocknote/mantine0.14.1 · 1×
@blocknote/react0.14.1 · 1×
@changesets/changelog-github0.5.0 · 1×

For agents

$ claude mcp add partykit \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact