Edit in GitHubLog an issue

Setting up Your Environment

During Developer Preview, please follow the steps below to acquire access and credentials, and to set up your local environment to build your first Project Firefly.

Acquire Access and Credentials#

Please first follow instructions in How to Get Access to Project Firefly to join the Developer Preview program.

Once you have been added to the program, you will need the following information for kicking off your development work.

  • An Adobe Experience Cloud Organization (required)
    • An Adobe Experience Cloud Org is required if you would like to use APIs from Adobe, access Developer Console, set up a Firefly project, publish custom applications, and/or access published custom applications.
    • As an enterprise customer or partner, you should have access to an Adobe Experience Cloud Org. If you do not have access to an organization:
      • Customers: Please contact your account manager for access.
      • Partners: Please contact your partner manager or request sandbox access via Adobe Solution Partner Portal.
  • Access to Adobe Developer Console (required)
    • Adobe Developer Console gives you access to APIs, SDKs and developer tools to build on, integrate, and extend Adobe products. You will set up your credentials using the Developer Console.
    • You must have developer role or system admin role for an Adobe Experience Cloud organization to access Adobe Developer Console.
  • A GitHub Account (optional)
    • A GitHub account is optional for setting up your CI/CD workflow.

Local Environment Set Up#

Required tools#

These prerequisites should be fulfilled on the developer's machine:

  • NodeJS >=12.22 ... 14.17-LTS, odd versions not recommended). It should also install npm together. We recommend using nvm to manage NodeJS installation and versions on the developer's machine.
  • Adobe I/O CLI
    • npm install -g @adobe/aio-cli
    • If you already have Adobe I/O CLI on your local, please ensure you have the latest version of Adobe I/O CLI installed. (Current version: NPM version)
      • For the Adobe I/O CLI, you can check the version through aio -v and compare it with npm show @adobe/aio-cli version. If your CLI is outdated, update your CLI by running npm install -g @adobe/aio-cli.
      • If your Adobe I/O CLI is up to date, you can simply run aio update to ensure all core plugins are updated as well.
      • Other than the checking the version on your CLI, whenever a new version of Adobe I/O CLI is updated, we will inform you on your command line by writing a message like this out before the command output. This message last for 7 days after a new release.
        Copied to your clipboard
        1› Warning: @adobe/aio-cli update available from 3.3.0 to 3.4.1.
        2› Run npm install -g @adobe/aio-cli to update.

Supported Local Environment#

We aim to provide the similar quality of local development experience on both Windows 10 and macOS 10.14 and higher. Our CLI and its plugins are automatically tested against NodeJS versions 10 and 12 on both Windows and Linux Xenial.

Supported terminals for the CLI#

Our CLI uses the popular inquirer package for all its interactive functionalities, such as the application generators.

See inquirer's Support section and its known issues for up-to-date details.

Optional tools#

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

The following commands must be executed to install the required Docker images:

Copied to your clipboard
1# NodeJS 10 images
2docker pull openwhisk/action-nodejs-v10:latest
3docker pull adobeapiplatform/adobe-action-nodejs-v10:3.0.21
4
5# NodeJS 12 images
6docker pull openwhisk/action-nodejs-v12:latest
7docker pull adobeapiplatform/adobe-action-nodejs-v12:3.0.22

Note: Developers on Windows machines should make sure that they are using Linux containers for the images above. The steps to switch to Linux containers are described in the Docker for Windows documentation.

Next Step#

Now that you have your environment set up, you can start creating your own Project Firefly application.

Copyright © 2021 Adobe. All rights reserved.