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

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

   

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 start the installation.

   

8. Once the codebase is installed, you are ready to try your application!

9. Go to the 'Build' option in the CLI (using the down arrow key 👇)

10. Hit enter on the platform you wish to test on.

11. Choose Development build if you are looking to test the app out. Once you are ready to pass it to others, choose Production build.

    

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.