Installation Instructions

Prerequisites

• Node.js 22+

Adobe Console preparation

Create a new project

Go to https://developer.adobe.com/console and create a new project from template: "App Builder"

Create an App Builder project using Adobe Developer Console. Reference: https://developer.adobe.com/app-builder/docs/get_started/app_builder_get_started/first-app

Installation

Step 1: Run npm install to install the dependencies

• Copy the environment configuration file: cp env.dist .env

• Connection of the local project to the Adobe Developer Console project:

aio login aio console org select aio console project select aio console workspace select aio app use --merge

Step 2: Edit the .env file with your project details. Set the following variables:

• Credentials encryption key (generate a random 32-character string)

CREDENTIALS_ENCRYPTION_KEY=YOUR_32_CHARACTER_ENCRYPTION_KEY

• Generate a random encryption key:

Use: openssl rand -hex 32

Or any 32-character random string

Commerce endpoints

Commerce base URL should finish with slash '/'

COMMERCE_BASE_URL=

SaaS Authenticaiton

Required for SaaS authentication and to authorize access to event management endpoints. Also needed for event provider creation and subscription in Adobe I/O Events.

These values can be copied from the Credential details page in AppBuilder under Organization > Project > Workspace > OAuth Server-to-Server.

OAUTH_CLIENT_ID=

OAUTH_CLIENT_SECRET=

OAUTH_TECHNICAL_ACCOUNT_ID=

OAUTH_TECHNICAL_ACCOUNT_EMAIL=

OAUTH_ORG_ID=

OAUTH_SCOPES=AdobeID, openid, read_organizations, additional_info.projectedProductContext, additional_info.roles, adobeio_api, read_client_secret, manage_client_secrets, event_receiver_api

PaaS Authentication

PaaS Only. OAuth credentials for Adobe Commerce On-Premise / Cloud

These values can be copied from the Integration Details page in Commerce under System > Integrations.

COMMERCE_CONSUMER_KEY=

COMMERCE_CONSUMER_SECRET=

COMMERCE_ACCESS_TOKEN=

COMMERCE_ACCESS_TOKEN_SECRET=

Check out the detailed steps to generate the Commerce Access Token and Secret Key.

https://experienceleague.adobe.com/en/docs/commerce-admin/systems/integrations

NOTE - The above variables must be configured compulsorily in the .env file.

Step 3: Run aio app deploy to deploy the app.

Tailwind CSS Generate Command

npm run build:css