Installation
Installation
Realtime SDK is available as npm packages for different frameworks and use cases.
React
For React applications, install the React SDK which includes hooks and the provider:
npm install @realtime-sdk/react
# or
pnpm add @realtime-sdk/react
# or
yarn add @realtime-sdk/react
Vanilla JavaScript
For framework-agnostic usage or custom integrations:
npm install @realtime-sdk/client
Server-side (Node.js)
For server-side authentication and webhooks:
npm install @realtime-sdk/node
Requirements
- Node.js 18+ (for server SDK)
- React 18+ (for React SDK)
- TypeScript 5.0+ (recommended, but not required)
Bundle Size
| Package | Size (gzipped) |
|---|---|
@realtime-sdk/client | ~8 KB |
@realtime-sdk/react | ~12 KB |
@realtime-sdk/node | ~5 KB |
Next Steps
Once installed, follow the Quick Start guide to set up your first real-time room.