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.


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

Get your API key and Secret key

This guide will help you to generate API key and secret from dashboard.

  • API Key is unique identifier used to authenticate a user calling to Video SDK API.
  • Secret Key cryptography relies on using the same key to encode and then later decode a message. Thus, only those who know the "secret" can read the message.

Step 1. Generate API Key from Dashboard

Go to Video SDK Dashboard, navigate to API Keys. Click on ADD NEW button to generate your own API key and Secret for the project.

Video SDK Home Dashboard

Step 2. Enter your Project Name

Enter your project name as shown below. Project name will help you to organise API keys and secrets for multiple projects and environments.

Video SDK Home Dashboard

Step 3. Use API key / Secret or Token

After submitting your project name, you can follow either of two paths:

  1. Development Env: You can just click on Generate Token and get started with the project setup.
  2. Production Env: For production, please setup authentication server to authenticate and authorize all the users.

Video SDK Home Dashboard

Run the Sample Project

Step 1: Clone the sample project

Clone the repository to your local environment.

git clone

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.


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