VideoSDK JS App

This project is a JavaScript application that utilizes the VideoSDK to create video conferencing functionality.

Table of Contents

• VideoSDK JS App
  • Table of Contents
  • Features
  • Prerequisites
  • Installation
  • Usage
  • Using ngrok for External Access
  • Configuration
  • API Reference
  • Contributing
  • License

Features

• Real-time video conferencing

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js (version 20.10.0 or higher)
• npm (version 10.9.0 or higher)
• A Zoom VideoSDK developer account and API keys

Installation

1. Clone the repository:

git clone [email protected]:zoom/videosdk-js-sample.git

2. Navigate to the project directory:

cd videosdk-js-sample

1. Install the dependencies:

npm install

Usage

1. Set up your environment variables (see Configuration section).

2. Start the development server:

npm start

3. Open your browser and navigate to http://localhost:3001?s=Subject&dn=DisplayName&r=1 (or the port you've configured).

Using ngrok for External Access

If you need to make your local development server accessible from the internet (e.g., for testing on different devices or sharing with others), you can use ngrok. Here's how to set it up:

1. Install ngrok:

• Visit ngrok.com and sign up for a free account.
• Download and install ngrok for your operating system.

2. Authenticate ngrok (you only need to do this once):

ngrok authtoken YOUR_AUTH_TOKEN

Replace YOUR_AUTH_TOKEN with the token provided in your ngrok dashboard.

3. Start your local development server as usual:

npm start

1. In a new terminal window, start ngrok:

ngrok http 3001

Replace with the port your app is running on if it's different than above.

1. ngrok will provide a public URL (e.g., https://1234abcd.ngrok.io?s=Subject&dn=DisplayName&r=1). You can use this URL to access your app from any device with internet access.

Note: The free version of ngrok will generate a new URL each time you restart it. If you need a consistent URL, consider upgrading to a paid plan.

Configuration

Copy the .env_copy and save as .env. It should look like the following:

ZOOM_SDK_KEY=''
ZOOM_SDK_SECRET=''

Replace with your actual VideoSDK API key and secret.

Important: Do not store credentials in plain text on production environments.

API Reference

For detailed information about the VideoSDK API, please refer to theofficial documentation.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.