Skip to content

Commit

Permalink
Merge pull request AdobeDocs#265 from asalloum5/update-config
Browse files Browse the repository at this point in the history
Update configuration page to add details on how to test locally pointing to a staging workspace
  • Loading branch information
keharper authored Aug 30, 2024
2 parents ea2e028 + 7bae873 commit 7eaa8e1
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions src/pages/admin-ui-sdk/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,36 @@ You can download a sample app from the [Adobe Commerce Samples repository](https

1. Change directories to `<repoRootDir>/admin-ui-sdk/menu/custom-menu`.

1. Run the following command to load dependencies.

```bash
npm install
```

1. Select your App Builder project.

```bash
aio console project select
```

1. Select the App Builder workspace.

```bash
aio console workspace select
```

1. Sync the App Builder project details.

```bash
aio app use
```

1. Build your solution.

```bash
aio app build
```

1. Run your custom menu extension locally.

```bash
Expand All @@ -175,3 +205,41 @@ You can download a sample app from the [Adobe Commerce Samples repository](https
![Fetched orders from Adobe Commerce page](../_images/first-app.png)

![First App on App Builder menu](../_images/fetched-orders.png)

### Test using project workspaces

Use the following steps to test a specific workspace from your project:

1. Deploy the app to the workspace.

```bash
aio app deploy
```

After deployment, the command displays the URL to your app workspace under `To view your deployed application:`

1. Change the values of the `name` and `href` fields in the `json_response` section of the `server.js` file to point to your workspace.

```json
{
"name": "app_name",
"title": "Test extension",
"description": "No",
"icon": "no",
"publisher": "aQQ6300000008LEGAY",
"endpoints": {
"commerce/backend-ui/1": {
"view": [{
"href": "https://<app_workspace_url>/index.html"
}]
}
},
"xrInfo": {
"supportEmail": "test@adobe.com",
"appId": "4a4c7cf8-bd64-4649-b8ed-662cd0d9c918"
},
"status": "PUBLISHED"
}
```

You can add multiple workspaces to the server to test several applications at once.

0 comments on commit 7eaa8e1

Please sign in to comment.