ArcGIS Experience Builder install

Install

The developer edition of ArcGIS Experience Builder supports ArcGIS Online and ArcGIS Enterprise 10.6 and later. There are two services for extending Experience Builder, the server and the client. You will need to have both services running to have your updates load in Experience Builder. To install the developer edition of Experience Builder, complete the following steps for the server install and client install. If you need to install Experience Builder without an internet connection, complete the offline install steps.

Server install

Create Client ID on ArcGIS Developers site

Use these steps if you're using developers.arcgis.com.

  1. Experience Builder uses Node.js. Long-term support (LTS) versions v12 and higher are supported. Download and install the latest Node.js LTS version for your operating system.
  1. Download the developer edition of Experience Builder and unzip it on your local drive.
  2. Sign to ArcGIS for Developers.
  3. Click the OAuth 2.0 tab.
  4. Click + New Application and enter your application's details to register your new app.
  5. Scroll down to the Redirect URLs tile.
  6. Add the URL https://localhost:3001/. Install
  1. Copy the Client ID.
  2. Open a command prompt or terminal window, cd to the /server directory of the Experience Builder installation, type npm ci, and hit enter to install the necessary modules.
  3. Type npm start to start the server.
  4. Open Experience Builder at the following URL https://localhost:3001/ in your browser.
  1. Specify the URL to your ArcGIS Online and add your Client ID > Sign in.
  2. Install the client.

Create Client ID using ArcGIS Online or ArcGIS Enterprise

Use these steps if you're using ArcGIS Online or ArcGIS Enterprise.

  1. Experience Builder runs on top of Node.js 12+.x, download and install Node.js (v12+.x) for your operating system.
  1. Download the developer edition of Experience Builder and unzip it on your local drive.
  2. Log in to your ArcGIS Online or ArcGIS Enterprise portal and go to My Content tab of the content page, click Add Item, and select An application.
  3. In the Add an application dialog box, enter the following parameters:
    • Type - Select Application as the type.
    • Title - Enter something that makes sense to you, such as Experience Builder credentials.
    • Tags - Enter something such as Experience Builder.
    • Click Add Item.

Application

  1. Click the Settings tab. Scroll down to the App Registration section and click Update.
  2. On the Register Info dialog box, as shown below, enter in https://localhost:3001/ for the Redirect URI, and click Add > Update. Copy the App ID.

Registered Info

  1. Open a command prompt or terminal window, cd to the /server directory of the Experience Builder installation, type npm ci, and hit enter to install the necessary modules.
  2. Type npm start to start the service.
  3. Open Experience Builder at the following URL https://localhost:3001/ in your browser.
  1. Specify the URL to your ArcGIS Online or ArcGIS Enterprise organization, and add your App ID for the Client ID > Sign in.
  1. Install the client.

Client install

To develop with Experience Builder, a service must be installed to launch webpack to help with bundling and loading your custom widgets and themes used in your local Experience Builder.

  1. Open a command prompt or terminal window, cd to the /client directory of the Experience Builder installation, type npm ci, and hit enter to install the necessary modules.
  2. Type npm start to start the service.

You can have multiple versions of the developer edition of Experience Builder on the same machine. Please check that your machine meets the System requirements.

Offline install

  1. In a disconnected environment you will not have access to the ArcGIS API JavaScript (JSAPI) CDN. In this scenario, you will be required to download the JSAPI and install it locally.
  2. Experience Builder runs on top of Node.js 12+.x, download and install Node.js (v12+.x) for your operating system.
  1. Download the developer edition of Experience Builder and unzip it on your local drive.
  2. Download the npm-cache zip for the developer edition of Experience Builder and unzip it on your local drive.
  3. Open your user folder (e.g., Windows OS c:\Users\exbuser) in a command prompt or terminal (e.g., macOS /Users/installExB) and type npm config get cache.
  4. Copy the folder path of the npm-cache and open that directory in Windows Explorer or Finder.
  5. Copy and paste the npm-cache directory (from step 3) into this directory.
  6. Open a command prompt or terminal window, cd to the /client directory of the Experience Builder installation, type npm install --offline, and hit enter.
  7. Open another command prompt or terminal window, cd to the /server directory of the Experience Builder installation, type npm install --offline, and hit enter.
  8. Open the client directory for your Experience Builder at the following path <install folder>/client/dist.
  9. There are four places you will need to update the variable arcgisJsApiUrl with your local JSAPI host URL. For example, replace var arcgisJsApiUrl = 'https://js.arcgis.com/4.21/' with var arcgisJsApiUrl = 'https://exb.esri.com/4.21/' in each of the files below:
    • <install folder>/client/dist/index.html
    • <install folder>/client/dist/experience/index.html
    • <install folder>/client/dist/template/index.html
    • <install folder>/client/dist/builder/index.html
  10. Open a command prompt or terminal window, cd to the /client directory of the Experience Builder installation, and type npm start to start the client service.
  11. Open a command prompt or terminal window, cd to the /server directory of the Experience Builder installation, and type npm start to start the server service.
  1. Log in to your ArcGIS Online or ArcGIS Enterprise portal and go to the My Content tab of the content page. Click Add Item and select An application.
  2. In the Add an application dialog box, enter the following parameters:
    • Type - Select Application as the type.
    • Title - Enter something that makes sense to you, such as Experience Builder credentials.
    • Tags - Enter something such as Experience Builder.
    • Click Add Item.

Application

  1. Click the Settings tab. Scroll down to the App Registration section and click Update.
  2. On the Register Info dialog box as shown below, enter in https://localhost:3001/ for the Redirect URI, and click Add > Update. Copy the App ID.
  3. Open Experience Builder at the following URL https://localhost:3001/ in your browser.
  4. Specify the URL to your ArcGIS Online or ArcGIS Enterprise organization and add your App ID for the Client ID > Sign in.

Install as a Windows Service

  1. Download and install the latest Node.js LTS version for your operating system.
  2. Open Windows command prompt as administrator.
  3. Change the directory (cd) to the /server directory of Experience Builder.
  4. Run the command npm ci to install the dependencies.
  5. Run the command npm run install-windows-service.
  6. Open the Windows Services app and start the Experience Builder service (default name: exb-server).
  7. To remove the Experience Builder service, run the command npm run uninstall-windows-service.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.