@maryam-dev/partykit

!npm beta
!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:

``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'reready, you can deploy your application on to the PartyKit cloud with npm run deploy.

Developers

- Documentation - /apps/docs
- Examples - /apps/docs/examples
- API References - /apps/docs/reference
- Guides - /apps/docs/guides
- Blog - /apps/blog`
- Release Notes

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.