Quick Start: Build and Run Your First App

Scaffold a Salesforce Multi-Framework app, run it locally against your org, and deploy it in about 10 minutes. This quick start uses React and the reactinternalapp template, which generates a complete Salesforce DX project, including the CustomApplication metadata that makes your app appear in the App Launcher.

For the concepts behind each step, and for options this quick start doesn’t cover (such as external apps or Agentforce Vibes), see Salesforce Multi-Framework Overview.

Before starting, make sure that you:

Generate a new Salesforce DX project from the internal React app template.

The generated project includes the UIBundle that holds your React app and the CustomApplication metadata that surfaces it in the App Launcher.

Install the app’s dependencies from inside the UIBundle directory, not the project root.

Start the local dev server.

Open http://localhost:5173 in your browser to see the app. To run against live org data, authenticate an org and set it as your default before you start the dev server.

With the dev server running, edit a component or page under src/ and save. The browser hot-reloads so you can see your change immediately. In VS Code, you can also open the Command Palette and run SFDX: Open in Live Preview to preview your app with org context. See Preview and Run Your App Locally.

When you’re ready, build the production assets and deploy the project.

Deploying the project deploys both the UIBundle and its CustomApplication metadata. To open your app, grant your user access to it through a permission set, and then find it in the App Launcher.

  1. Assign the app’s permission set to your user. If the template generated one, run sf org assign permset --name MyFirstApp_Access. Otherwise, in Setup, use Permission Sets or the app’s profile to grant access to the CustomApplication.
  2. Open the App Launcher, search for MyFirstApp, and open it.

For the full deployment, versioning, and publication workflow, see Deploy and Publish a UIBundle.