https://github.com/partykit/partykit
PartyKit simplifies developing multiplayer applications
https://github.com/partykit/partykit
backends collaboration crdts durable-objects edge-computing games gaming multiplayer real-time realtime websockets yjs
Last synced: 2 days ago
JSON representation
PartyKit simplifies developing multiplayer applications
- Host: GitHub
- URL: https://github.com/partykit/partykit
- Owner: partykit
- License: mit
- Created: 2022-12-10T16:44:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T11:39:44.000Z (about 2 months ago)
- Last Synced: 2025-05-14T09:02:26.515Z (2 days ago)
- Topics: backends, collaboration, crdts, durable-objects, edge-computing, games, gaming, multiplayer, real-time, realtime, websockets, yjs
- Language: TypeScript
- Homepage: https://docs.partykit.io/
- Size: 96.6 MB
- Stars: 5,094
- Watchers: 28
- Forks: 176
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - partykit/partykit - PartyKit simplifies developing multiplayer applications (TypeScript)
- awesome - partykit/partykit - PartyKit simplifies developing multiplayer applications (TypeScript)
- awesome-ccamel - partykit/partykit - PartyKit simplifies developing multiplayer applications (TypeScript)
README
[](https://discord.gg/g5uqHQJc3z)
[PartyKit](https://partykit.io/) 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](https://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:
```sh
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:
```sh
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
- [Documentation](https://docs.partykit.io/) - [`/apps/docs`](./apps/docs)
- [Examples](https://docs.partykit.io/examples) - [`/apps/docs/src/content/docs/examples`](./apps/docs/src/content/docs/examples)
- [API References](https://docs.partykit.io/reference/) - [`./apps/docs/src/content/docs/reference`](./apps/docs/src/content/docs/reference)
- [Guides](https://docs.partykit.io/guides) - [`./apps/docs/src/content/docs/guides`](./apps/docs/src/content/docs/guides)
- [Release Notes](https://github.com/partykit/partykit/releases)
- [Blog](https://blog.partykit.io/) - [`/apps/blog`](./apps/blog)
## Community and support
- [GitHub issues](./issues) to report bugs 🐛
- [Discord](https://discord.gg/vwDWs68C) to ask questions, share your ideas and feedback, and help us celebrate your PartyKit projects 💕
- [Twitter](https://x.com/partykit_io) 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](https://discord.gg/g5uqHQJc3z).
## License
PartyKit is [MIT licensed](./LICENSE).