Set Up Local Environment

This guide includes instructions for setting up a local environment for UI Extension development.

To create UI Extension you must install:

1. NodeJS [>= v14]. It should also install npm together. We recommend using nvm to manage NodeJS installation and versions on your machine.
2. AIO (Adobe I/O) CLI (Command Line Interface) [>= v9.1.0]

If your extension needs some server-side logic and you want to be able to use aio app run --local to run the application locally without deploying code to Adobe I/O Runtime you will also need:

1. Java Development Kit (JDK) [>= v11].
2. Docker.

Manage AIO CLI Tool

Run the following command to install the latest version of AIO CLI if not installed.

Copy
npm install -g @adobe/aio-cli
Copied to your clipboard
npm install -g @adobe/aio-cli

If you already have AIO CLI on your machine, you can find out the version with the following command.

Copy
npm show @adobe/aio-cli version
Copied to your clipboard
npm show @adobe/aio-cli version

If your AIO CLI is outdated, update it by running the following command.

Copy
npm install -g @adobe/aio-cli
Copied to your clipboard
npm install -g @adobe/aio-cli

Optional tools

The following set up is required if you intend to use the local development features provided by the AIO CLI:

• Visual Studio Code (VS Code) as the supported IDE for editor, debuggger, etc. You can use any other IDE as a code editor, but advanced usage (e.g. debugger) is not yet supported.
• Chrome debugger extension in VSCode

Additional resources

• App Builder Local Environment Set Up and optional tools.

Last updated 11/1/2022

Was this helpful?

Yes

No