ArcGIS for Developers

ArcGIS Experience Builder install

Install

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 for Experience Builder, complete the following steps for the server install and client install.

Server install

Create Client ID on ArcGIS Developers site

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

  1. Experience Builder runs on top of Node.js 10+.x, download and install Node.js (v10+.x) for your operating system.
  2. Download the Experience Builder for Developer edition and unzip it on your local drive.
  3. Sign to ArcGIS for Developers.
  4. Click New Application.
  5. In the New Applications Details, enter the following:
    • Title - Enter something that makes sense to you, such as Experience Builder credentials.
    • Tags - Enter something such as Experience Builder.
    • Click Register New Application.
  6. Click the Authentication tab for the application you just registered. In the Current Redirect URIs section, enter in https://localhost:3001/ for the Redirect URI and click + Add.

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.
Tip:

Experience Builder uses a self-signed certificate in Node.js to support HTTPS. You can run Experience Builder using this certificate by trusting it or you can use your own certificate. To change the default certificate with your own, replace these two files in the server/cert directory: server.key and server.cert.

  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 10+.x, download and install Node.js (v10+.x) for your operating system.
  2. Download the Experience Builder for Developer edition and unzip it on your local drive.
  3. 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.
  4. 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.
Tip:

Experience Builder uses a self-signed certificate in Node.js to support HTTPS. You can run Experience Builder using this certificate by trusting it or you can use your own certificate. To change the default certificate with your own, replace these two files in the server/cert directory: server.key and server.cert.

  1. Specify the URL to your ArcGIS Online or ArcGIS Enterprise organization and add your App ID for the Client ID > Sign in.
  2. Install the client.

Client install

In order to develop with Experience Builder a service must be installed to launch webpack to help with the distribution of widgets, etc.

  1. Copy the the simple folder located in client/sample-widgets and paste it into client/your-extensions/widgets. There needs to be at least one widget in this directory to run the client service below.
  2. 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.
  3. Type npm start to start the service.
Tip:
New files/folders created in the client/your-extensions directory will require a restart of the client server.

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