Compile and run a sample project

Agora provides Open-source sample projects on GitHub to demonstrate the implementation of basic and advanced Video SDK features.

This page shows how to compile, configure, and run the Video SDK ReactJS sample project.

• A supported browser.
• A JavaScript package manager such as npm.

• A camera and a microphone

• A valid Agora account and project. Please refer to Agora account management for details.

• Installed Git

Run the following command to clone the GitHub repository locally:

git clone https://github.com/AgoraIO/API-Examples-Web

The GitHub examples repository provides the following projects:

Description	Path
Feature demos	/Demo
Extension demos	/ExtensionDemo
Vue framework examples	/vue/api-examples
React framework examples	/react/api-examples

Navigate to /react/api-examples and run the following command to install the dependencies.

npm install

1. Use the following command to run the sample project.

   npm run dev
   

2. On the demo page, enter your App ID, token, and channel name and join the channel.

   The channel name must be the same as the channel ID you used to generate the token.