Compile and run a sample project
Updated
Compile and run a project using Agora SDK
Agora provides Open-source sample projects on GitHub to demonstrate the implementation of basic and advanced RTC SDK features.
This page shows how to compile, configure, and run the RTC SDK JavaScript sample project.
Prerequisites
- 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
Project setup
Get the sample project
Run the following command to clone the GitHub repository locally:
git clone https://github.com/AgoraIO/API-Examples-WebThe 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 |
Configure the sample project
Navigate to /react/api-examples and run the following command to install the dependencies.
npm install