Skip to content

Commit f843410

Browse files
committed
Fix error and update packages
1 parent 087469f commit f843410

18 files changed

Lines changed: 3026 additions & 2982 deletions

File tree

INSTALL.md

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
- Node.js 18+
66
- Adobe I/O CLI
7+
- For PaaS integration with Admin UI: Adobe Commerce Admin UI SDK v3+ (see [Installation Guide](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/installation/))
78

89
## Adobe Console preparation
910

@@ -31,9 +32,25 @@ To required environment add:
3132

3233
1. Clone the repository
3334
2. Run `npm install` to install the dependencies
34-
3. Go to [Project](https://developer.adobe.com/console), select Environment and click on "Download All" button.
35-
4. Copy the env.dist file into .env file. `cp env.dist .env`
36-
4. Execute `aio app use <path-to-file>` with file you just downloaded. (Merge files if you already have .env file)
35+
3. Copy the env.dist file into .env file: `cp env.dist .env`
36+
4. Configure the project environment using one of the following methods:
37+
38+
**Option A: Download configuration from Console**
39+
40+
- Go to [Adobe Developer Console](https://developer.adobe.com/console), select your Project and Environment
41+
- Click on "Download All" button
42+
- Execute `aio app use <path-to-downloaded-file>` (Merge files if you already have .env file)
43+
44+
**Option B: Configure via CLI**
45+
46+
```bash
47+
aio login
48+
aio console org select
49+
aio console project select
50+
aio console workspace select
51+
aio app use
52+
```
53+
3754
5. Edit `.env` file with your project details.
3855
Set following variables:
3956

@@ -64,9 +81,12 @@ COMMERCE_BASE_URL= // Commerce instance REST API Url
6481

6582
In env.dist file you will find set of Auth parameters.
6683

67-
**For Adobe Commerce PaaS:**
84+
**For Adobe Commerce (PaaS Only):**
6885

69-
These values can be copied from the Integration Details under System > Integrations in your Adobe Commerce backend
86+
> [!NOTE]
87+
> For SaaS Installation those values are not needed and can be skipped.
88+
89+
These values can be copied from the Integration Details under System > Integrations in your Adobe Commerce backend.
7090

7191
```
7292
COMMERCE_CONSUMER_KEY=
@@ -75,7 +95,7 @@ COMMERCE_ACCESS_TOKEN=
7595
COMMERCE_ACCESS_TOKEN_SECRET=
7696
```
7797

78-
**For Adobe Commerce SaaS:**
98+
**For Adobe Commerce (SaaS & PaaS):**
7999

80100
Documentation how to get these values is available here: https://developer.adobe.com/developer-console/docs/guides/authentication/ServerToServerAuthentication/implementation
81101

@@ -108,4 +128,32 @@ For Adobe Commerce SaaS, you can add the module to be available in your Commerce
108128
3. Click "Configure extensions" and choose respective Environment and Application.
109129
4. Save changes.
110130

111-
For more information and troubleshooting please go to: https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/configuration/
131+
For more information and troubleshooting please go to: https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/configuration/
132+
133+
## Adding to Adobe Admin UI (PaaS)
134+
135+
For Adobe Commerce PaaS (On-Premise/Cloud), you need to install and configure the Admin UI SDK module.
136+
137+
### Install the Admin UI SDK Module
138+
139+
1. Install the module via Composer:
140+
141+
```bash
142+
composer require "magento/commerce-backend-sdk": ">=3.0"
143+
```
144+
145+
2. Enable the module (for On-premises installation):
146+
147+
```bash
148+
bin/magento module:enable Magento_AdminUiSdk
149+
bin/magento setup:upgrade
150+
bin/magento cache:clean
151+
```
152+
153+
### Configure the Admin UI SDK
154+
155+
Follow the official Adobe documentation for configuration steps:
156+
- [Admin UI SDK Configuration](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/configuration/)
157+
158+
For detailed installation instructions, please refer to:
159+
- [Admin UI SDK Installation](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/installation/)

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Module compatible with both Adobe Commerce SaaS and PaaS.
88

99
Please see [INSTALL.md](INSTALL.md) for more details.
1010

11+
> [!IMPORTANT]
12+
> This application is designed to run within the Adobe Experience Cloud Shell or Adobe Commerce Admin UI.
13+
> Viewing the deployed application directly via its URL outside of these environments will result in the UI not loading correctly.
14+
> Always access the application through the Experience Cloud Shell or via the Adobe Commerce Admin panel.
15+
1116
## Home page / Grid
1217

1318
On the application home page you will see list of the feeds:
@@ -258,10 +263,10 @@ Add attributes.value is an Array of attributes, to get specific attribute, you c
258263
```xml
259264
<item>
260265
<sku>{{sku}}</sku>
261-
<weight>{{description}}</weight>
266+
<description>{{description}}</description>
262267
<image>{{images.url count="2"}}</image>
263268
<color>{{attributes.value code='color'}}</color>
264-
<color>{{attributes.value code='weight'}}</color>
269+
<weight>{{attributes.value code='weight'}}</weight>
265270
<price>{{SimpleProductView||price.final.amount.value}} {{SimpleProductView||price.final.amount.currency}}</price>
266271
</item>
267272
```

adobe-api/mesh/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ If Adobe Mesh Gql response fail need to check source URL (magento.host): SSL cer
6363
"handler": {
6464
"openapi": {
6565
"source": "https://magento.host/rest/schema?services=storeWebsiteRepositoryV1",
66-
// can be updated to /rest/schema?services=all if we want to use all rest enpoint in mesh
66+
// can be updated to /rest/schema?services=all if we want to use all rest endpoint in mesh
6767
6868
"schemaHeaders": {
6969
"Authorization": "Bearer {context.headers['x-ac-api-token']}"
70-
// magento integration api token. Must be included to Headers in request to Mesh GQl enpoint
70+
// magento integration api token. Must be included to Headers in request to Mesh GQl endpoint
7171
},
7272
"operationHeaders": {
7373
"Authorization": "Bearer {context.headers['x-ac-api-token']}",

install.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ $id: https://adobe.io/schemas/app-builder-templates/1
44
categories:
55
- action
66
- ui
7-
- graphql-mesh
87
- events
98
- helper-template
109

@@ -17,6 +16,7 @@ apis:
1716
- code: AdobeIOManagementAPISDK
1817
- code: AdobeCommerceWithAdobeID
1918
- code: GraphQLServiceSDK
19+
- code: ACCS-REST-API
2020

2121
extensions:
2222
- extensionPointId: commerce/backend-ui/1

0 commit comments

Comments
 (0)