# Compile and run a sample project (/en/realtime-media/broadcast-streaming/build/set-up-your-project/compile-run-sample-project/web)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

Agora provides [Open-source sample projects on GitHub](https://github.com/AgoraIO/API-Examples-Web) to demonstrate the implementation of basic and advanced Video SDK features.

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

    ## Prerequisites [#prerequisites-3]

    * A [supported browser](reference/supported-platforms).
      Agora strongly recommends using the latest stable version of Google Chrome.

    * [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

    * A camera and a microphone

    * A valid Agora account and project. Please refer to [Agora account management](../manage-agora-account) for details.

    * Installed [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

    ## Project setup [#project-setup-3]

    ### Get the sample project [#get-the-sample-project-3]

    Obtain the sample project using one of the following methods:

    * Go to the [SDKs](../../../sdks) page, download the latest version of Video SDK, and unzip it.

    * Run the following commands to clone the GitHub repository locally:

      ```bash
      git clone https://github.com/AgoraIO/API-Examples-Web
      cd API-Examples-Web
      git checkout new
      ```

    The `API-Examples-Web` repository provides the following examples:

    | Description             | Path                           |
    | :---------------------- | :----------------------------- |
    | Basic examples          | `/src/example/basic`           |
    | Advanced examples       | `/src/example/advanced`        |
    | Plug-in examples        | `/src/example/plugin`          |
    | Other examples          | `/src/example/others`          |
    | Vue framework example   | `/src/example/framework/vue`   |
    | React framework example | `/src/example/framework/react` |

    ### Configure the sample project [#configure-the-sample-project-3]

    1. Install dependencies

    In the project root folder, run the following command to install the dependencies:

    ```bash
    npm install
    ```

    2. To launch the project, run the following command in the project root folder:

       ```bash
       npm run dev
       ```

    After execution is complete, the terminal displays the URL to launch the demo.

    3. Set App ID and temporary Token

    Open `http://localhost:3001/index.html` in your browser , fill in the App ID and App certificate you obtained from the Agora console, and then click **Set**. Both primary and secondary certificates are acceptable.

    ![image](https://assets-docs.agora.io/images/video-sdk/run-compile-web-step-1.png)

    <CalloutContainer type="info">
      <CalloutDescription>
        If you have enabled joining with only the App ID for your project, leave the App certificate field blank.
      </CalloutDescription>
    </CalloutContainer>

    ## Run the sample project [#run-the-sample-project-3]

    1. From the menu, choose the feature or use-case you want to experience.

    2. As an example, try the screen sharing demo, click **Join as host** to join a channel as the host. Ask a friend to run the sample project on another device and **Join as audience**, using the same app ID, app certificate, and channel name. Now you can share the screen with your friend.

       ![image](https://assets-docs.agora.io/images/video-sdk/run-compile-web-step-2.png)

    
  
      
  
      
  
      
  
      
  
      
  
      
  
      
  
      
  
      
  
