Skip to main content

Quickstart Guide

Once you have customized your application with Agora App Builder, you can launch your Web app directly through the visual designer with our 1-click deploy integrations for Vercel.

This guide helps you get started with your web app as well as build your app for other Mobile and Desktop platforms.

Step 1 - Customize and launch your web app

  1. Use the Agora App Builder to customize your app.
  2. Deploy through Vercel using the Deploy Your App button.
  3. Congrats! You have a Live Video Room Web app! 🎉

Step 2 - Test and launch native apps

Using Command Line Interface (UI)

  1. Click the Download Source Code button on the App Builder.
  2. Unzip the downloaded folder
  3. Open the agora-app-builder folder inside Terminal or Command Prompt.
  4. Set up your development environment by following this guide
  5. Run the following command: npm i && npm start
    CLI Start
  6. This will launch the App Builder CLI, where you can install and build your applications. The App Builder CLI allows you to easily Install and Build apps.
  7. First, you have to install the codebase onto your local machine. Press Enter to proceed.
    CLI Launch
  8. Next, Select config file for installation. By default config.json will be selected.
    CLI Install Config Select
  9. Optional, You can create additional config file in this format - (config.*.json) to support different environment
    CLI Install Config Dev
  10. Once the codebase is installed, you are ready to try your application!
    CLI Install
  11. Now press Enter to continue and Select 'Build' option in the CLI
  12. Hit enter on the platform you wish to test on.
  13. Choose Development build if you are looking to test the app out. Once you are ready to pass it to others, choose Production build.
    CLI Build

Using Direct Commands

  1. Click the Download Source Code button on the App Builder.
  2. Unzip the downloaded folder
  3. Open the agora-app-builder folder inside Terminal or Command Prompt.
  4. Set up your development environment by following this guide
  5. Run the following command to install agora-app-builder-cli
npm i -g agora-app-builder-cli@latest
  1. Run the following command to install AppBuilder
agora-app-builder-cli install
  1. Optional, You can create additional config file in this format - (config.*.json) to support different environment and pass it using --config Example: agora-app-builder-cli install --config='config.dev.json'
  2. Run the following command to Build the project for web
agora-app-builder-cli build web --prod
  1. Optional, Run the following commnad to explore commands in the agora-app-builder-cli
agora-app-builder-cli --help

Step 3 - Distribute your app

  • To distribute the app to a CDN like Vercel or Netlify, You can refer to our detailed build guide here

  • If you want to submit this app to the App Store or Play Store, follow this guide to codesign your app, to adhere to the requirements from Apple and Google.

© 2024 Agora.io, Inc