Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/livekit-examples/livestream
https://github.com/livekit-examples/livestream
livestreaming nextjs rtmp vercel webrtc
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/livekit-examples/livestream
- Owner: livekit-examples
- License: apache-2.0
- Created: 2023-02-14T15:27:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T09:32:12.000Z (6 months ago)
- Last Synced: 2024-06-10T15:47:41.437Z (5 months ago)
- Topics: livestreaming, nextjs, rtmp, vercel, webrtc
- Language: TypeScript
- Homepage: https://livestream-demo.livekit.io
- Size: 340 KB
- Stars: 103
- Watchers: 6
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LiveKit Livestreaming Demo
This is a demo app for livestreaming via RTMP or WHIP using LiveKit. One user is a broadcaster who gets an RTMP/WHIP for streaming (eg, via OBS). Other users can view their stream and chat. We also let you broadcast directly from your device from the "Host" page.
Today most livestreams experience a 5–30 second lag, which is evident in the delay it takes for streamers to respond to chats. Those streams use HLS, which leverages existing CDNs by uploading 5–30 second video chunks, which clients download one chunk at a time. HLS is hugely scalable, but it comes with latency.
LiveKit is a sort of WebRTC CDN, achieving sub-100ms latency for audiences of 1000 or 100,000 by streaming video over backbone Internet connections and only going over the public Internet for the last mile (that is, delivery to connected clients). This enables true real-time, large-scale events, where anyone and everyone can participate.
This sample app only leverages the following technologies:
- [Next.js 14](https://nextjs.org)
- [Tailwind CSS](https://tailwindcss.com)
- [shadcn/ui](https://github.com/shadcn/ui)
## Running locally
Clone the repo and install dependencies:
```bash
git clone [email protected]:livekit-examples/livestream.git
cd livestream
npm install
```
Create a new LiveKit project at . Then create a new key in your [project settings](https://cloud.livekit.io/projects/p_/settings/keys).
Create a new `.env.development` file and add your new API key and secret as well as your project's WebSocket URL (found at the top of ):
```
LIVEKIT_API_KEY=
LIVEKIT_API_SECRET=
LIVEKIT_API_URL=https://.livekit.cloud
NEXT_PUBLIC_LIVEKIT_WS_URL=wss://.livekit.cloud
```
Then run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
You can test it by opening in a browser.
## Deploying
This demo is a Next.js app. You can deploy to your Vercel account with one click:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flivekit-examples%2Flivestream&env=LIVEKIT_API_KEY,LIVEKIT_API_SECRET,LIVEKIT_API_URL,NEXT_PUBLIC_LIVEKIT_WS_URL&envDescription=Sign%20up%20for%20an%20account%20at%20https%3A%2F%2Fcloud.livekit.io%20and%20create%20an%20API%20key%20in%20the%20Project%20Settings%20UI)
Refer to the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more about deploying to a production environment.