Install
- Download the Web AppBuilder for ArcGIS (Developer Edition) ZIP file to your local drive and unzip it.
- Because Web AppBuilder runs on top of Node.js, you must have Node.js installed on your computer. The download package contains the Windows version of node.js.
- If you are on a Windows platform, you can follow the steps in the next section to start Web AppBuilder.
- If you are on a platform other than Windows, such as Mac or Linux, you need to install Node.js specifically on your platform first. In case you already have Node.js installed, make sure its version is 0.10.0 and later.
Note:
The minimum version of node.js supported by Web AppBuilder is 0.10.0.
Start Web AppBuilder
- Start Web AppBuilder based on your platform.
- On Windows, double-click the startup.bat file in the unzipped folder. The batch file starts the Node.js server in the Command Prompt window and Web AppBuilder in your default browser with http://[yourmachinename]:3344/webappbuilder. If the browser is closed, you can reopen Web AppBuilder in the same—or a different—browser as long as Node.js is running in the Command Prompt window.
- On other platforms, open the Command Prompt window, cd to the /server directory of the Web AppBuilder installation, and type node server.js. Once Node.js runs, start Web AppBuilder in the browser with http://[yourmachinename]:3344/webappbuilder. If the browser is closed, you can reopen Web AppBuilder in the same—or a different—browser as long as Node.js is running in the Command Prompt window.
- Web AppBuilder runs on top of Node.js with the default port of 3344. To run Web AppBuilder with additional parameters, different ports, or as a Windows Service, complete the following steps. Otherwise, see the Specify your portal URL section.
- Run with additional parameters and different ports.
- Open a command window and browse to the /server directory of the Web AppBuilder installation.
- On 64-bit Windows, type node_x64.exe server.js [-port=value] [-proxy=value].
- On 32-bit Windows, type node_x32.exe server.js [-port=value] [-proxy=value].
- On other platforms, type node server.js [-port=value] [-proxy=value].
Note:
-port specifies the port you want Node.js to run on, and -proxy specifies the proxy URL if needed.
- Start Web AppBuilder in the browser with the port number specified above at http://[yourmachinename]:[yourport]/webappbuilder.
Tip:
If you have problems starting Web AppBuilder, see FAQs for more information.
- Open a command window and browse to the /server directory of the Web AppBuilder installation.
- Run as a Windows service:
- Install Node.js on your Windows platform.
- Run Command Prompt as administrator.
- Browse to the /server directory of Web AppBuilder, and run the npm install command.
- Run the npm run-script install-windows-service command.
- Start the ArcGISWebAppBuilder service from the Services window.
- To remove the ArcGISWebAppBuilder service, run the npm run-script uninstall-windows-service command.
- Run with additional parameters and different ports.
Specify your portal URL
- Specify the URL for the ArcGIS Online organization or Portal for ArcGIS account that you want Web AppBuilder to access. To use Web AppBuilder, you must have an ArcGIS Online organization account, a Portal for ArcGIS account, or a ArcGIS for Developers account.
Subscription:
Sign up for the ArcGIS Online Trial account at http://www.esri.com/software/arcgis/arcgisonline/evaluate.
- Click Continue.
Provide App ID for Web AppBuilder
Since this is the first time you‘ve used Web AppBuilder with the portal specified above, you may be asked to provide an App ID for Web AppBuilder to support OAuth 2 authentication. For a specified portal, this process is required one time. When you subsequently start Web AppBuilder, you can log in to the portal directly.
Do the followings to retrieve an App ID
- Log in to the portal you specified above.
- Add Web AppBuilder as an item.
- For ArcGIS Online organization or Portal for ArcGIS 10.3.1 and up:
- go to My Content, pull down Add Item and select An Application.
- In the Application dialog, for URL, enter http://[yourmachinename]:3344/webappbuilder. For Title, enter something that makes sense to you, such us Web AppBuilder for ArcGIS . For Tags, enter something that is easy for search, such as Registered Web AppBuilder.
- Keep the rest of options as default.
- Click ADD ITEM.
- For Portal for ArcGIS 10.3:
- Go to My Content, click + Add Item.
- In the Add Item dialog, pull down The item is and select An application. For URL, enter http://[yourmachinename]:3344/webappbuilder. For Title, enter something that makes sense to you, such us Web AppBuilder for ArcGIS. For Tags, enter something that is easy for search, such as Registered Web AppBuilder.
- Keep the rest of options as default.
- Click ADD ITEM.
- For ArcGIS Online organization or Portal for ArcGIS 10.3.1 and up:
- In the item details page, click REGISTER under App Registration section.
- In the Register dialog, for Redirect URI, add http://[yourmachinename]and https://[yourmachinename] as redirect URIs. Be aware that URIs with HTTP and HTTPS protocols are distinguished as two different URIs. It is strongly recommended adding both of them to the URI list to avoid potential redirect issues.
- Keep the default value for App Type and click REGISTER.
- In the item details page, copy the App ID under App Registration.
- In the browser, paste the App ID into the text box of Web AppBuilder, and click Continue.
If you get Error 400 with Invalid redirect_url, complete the following steps.
- Go to /server directory of the Web AppBuilder installation, delete signininfo.json file.
- Review step 4. Update the existing App ID with the correct redirect URIs. You can also create a new App ID from the scratch.
- Refresh the browser running Web AppBuilder.
- Provide your App ID again, and click Continue.
- Enter your credentials if not already logged in, or click APPROVE with Request for Permission dialog.
An App ID is required by OAuth 2 authentication. See Authentication and OAuth 2. If you have problems logging on, see FAQs and Add apps and register your app
Build your first app
You are now ready to build your first app.