https://github.com/livekit/node-sdks
LiveKit realtime and server SDKs for Node.JS
https://github.com/livekit/node-sdks
livekit nodejs
Last synced: 2 months ago
JSON representation
LiveKit realtime and server SDKs for Node.JS
- Host: GitHub
- URL: https://github.com/livekit/node-sdks
- Owner: livekit
- License: apache-2.0
- Created: 2021-01-22T07:20:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-27T01:28:36.000Z (2 months ago)
- Last Synced: 2025-07-27T07:36:47.610Z (2 months ago)
- Topics: livekit, nodejs
- Language: TypeScript
- Homepage: https://docs.livekit.io
- Size: 4.71 MB
- Stars: 211
- Watchers: 16
- Forks: 84
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LiveKit Node SDKs
Use this SDK to add realtime video, audio and data features to your Node app. By connecting to LiveKit Cloud or a self-hosted server, you can quickly build applications such as multi-modal AI, live streaming, or video calls with just a few lines of code.
### Warning
Avoid running this with hot reloads (ex. [bun's hot reload](https://bun.sh/guides/http/hot)). This is known to cause issues with WebRTC connectivity.
## Monorepo Navigation
- **Packages**:
- [Server SDK](/packages/livekit-server-sdk) - to interact with server APIs.
- [Node realtime SDK](/packages/livekit-rtc) - to connect to LiveKit as a server-side participant, and to publish and subscribe to audio, video, and data.
- **Examples**
- [Webhooks HTTP (server SDK)](/examples/webhooks-http/README.md)
- [Webhooks NextJS (server SDK)](/examples/webhooks-nextjs/README.md)
- [Publishing to a room (realtime SDK)](/examples/publish-wav/)
## Development Setup
If you are interested in contributing to the project or running the examples that are part of this mono-repository, then you must first set up your development environment.
### Setup Monorepo
This repo consists of multiple packages that partly build on top of each other.
It relies on pnpm workspaces and [Turborepo](https://turbo.build/repo/docs) (which gets installed automatically).
Clone the repo and run `pnpm install` the root level:
```shell
pnpm install
```
In order to link up initial dependencies and check whether everything has installed correctly run
```shell
pnpm build
```
This will build all the packages in `/packages` and the examples in `/examples` once.
After that you can use a more granular command to only rebuild the packages you are working on.
### Setup Submodules
Run the following command to install the submodules.
```shell
git submodule update --init --recursive
```
Then run `pnpm build` to make sure everything is up to date.
LiveKit Ecosystem
LiveKit SDKsBrowser · iOS/macOS/visionOS · Android · Flutter · React Native · Rust · Node.js · Python · Unity · Unity (WebGL) · ESP32
Server APIsNode.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community) · .NET (community)
UI ComponentsReact · Android Compose · SwiftUI · Flutter
Agents FrameworksPython · Node.js · Playground
ServicesLiveKit server · Egress · Ingress · SIP
ResourcesDocs · Example apps · Cloud · Self-hosting · CLI