NodeJS Backend Quickstart

Install the LiveKit SDKs for the server and client:

Copied!
yarn add livekit-server-sdk

Copied!
npm install livekit-server-sdk --save

Create a new file at development.env and with your API Key and Secret:

Reveal API secret
Copied!
export LIVEKIT_API_KEY=<API Key>
export LIVEKIT_API_SECRET=<API Secret hidden>

Create a server that returns a token for a participant to join a room:

Copied!
import express from 'express';
import { AccessToken } from 'livekit-server-sdk';

const createToken = () => {
  // if this room doesn't exist, it'll be automatically created when the first
  // client joins
  const roomName = 'quickstart-room';
  // identifier to be used for participant.
  // it's available as LocalParticipant.identity with livekit-client SDK
  const participantName = 'quickstart-username';

  const at = new AccessToken('api-key', 'secret-key', {
    identity: participantName,
  });
  at.addGrant({ roomJoin: true, room: roomName });

  return at.toJwt();
}

const app = express();
const port = 3000;

app.get('/getToken', (req, res) => {
  res.send(createToken());
});

app.listen(port, () => {
  console.log(`Server listening on port ${port}`)
})

Run the server:

Copied!
$ source development.env
$ node server.js

Create a client app that fetches a token from the server you just made, then uses it to connect to a LiveKit room:

React

Swift

Android

Flutter

Rust

JavaScript