Skip to content
PartyKit Docs
Search
Cancel
GitHub
Discord
Twitter
Select theme
Dark
Light
Auto
Get Started
Quickstart
Add to existing project
What is PartyKit
How PartyKit works
Tutorials
Add PartyKit to a Next.js app
1. What you will build
2. Set up PartyKit server
3. Hook up data to the server
4. Add WebSockets
5. Broadcast the change
6. Add storage
7. Deploy your poll app
Guides
Building a WebSocket server
Authentication
Deploying a PartyKit server
Handling binary messages
Managing env variables
Persisting state into storage
Rate limiting messages
Responding to HTTP requests
Scaling PartyKit servers with Hibernation
Scheduling tasks with Alarms
Serving static assets
Setting up CI/CD with Github Actions
Using multiple parties per project
Validating client inputs
Examples
All PartyKit Examples
App examples
Active user avatars
Chat app with user avatars, AI agents, and auth (Next.js)
Connection Counter
Cursors with country flags
Falling sand game (three.js)
Live polls (a Next.js app)
Live polls (web component)
Mosaic - collaborative game
Multiplayer AI chat rooms
Multiplayer text editor
Realtime reaction counter
The Namib Desert watering hole livestream
Two-way hyperlinks and social webpages
YouTube watch party
Starter kits
Game starter (Next.js + Redux)
Remix starter
Replicache starter
TinyBase starter
API Reference
Overview
PartyKit CLI
Party.Server (Server API)
PartySocket (Client API)
Y-PartyKit (Yjs API)
Configuration (partykit.json)
Glossary
Enterprise
Select theme
Dark
Light
Auto
Overview
Party.Server
(Server) API
PartySocket
(Client) API
partykit
Command-Line Interface (CLI)
partykit.json
Configuration file
y-partykit
(Y.js) API