Skip to main content
Version: 0.0.x

Run a Sample Project

Video SDK provides open-source sample project videosdk-rtc-javascript-sdk-example on Github. This document introduces how to run this project.

Prerequisites

  • Live Server (Any other server will work)
  • Valid Video SDK Account

Generate Token

To manage secured communication, every participant that connects to a meeting needs an access token. You can easily generate this token by using your apiKey and secret-key, which you can obtain from the VideoSDK Dashboard.

For development purpose, you can generate a temporary token from VideoSDK Dashboard's API section.


tip

The best practice for obtaining a token involves generating it from your backend server which will help in keeping your credentials safe.

Run the Sample Project

Step 1: Clone the sample project

Clone the repository to your local environment.

git clone https://github.com/videosdk-live/videosdk-rtc-javascript-sdk-example.git

Step 2: Copy the config.example.js file to config.js file.

Open your favorite code editor and copy config.example.js to config.js file.

cp config.example.js config.js

Step 3: Modify config.js file

Paste earlier generated temporary token here.

config.js
TOKEN = "TEMPORARY-TOKEN";

Step 4: Run the sample app

You can install and use live-server or just use any server to host the project. Bingo, it's time to push the launch button.

live-server --port=8000

Got a Question? Ask us on discord