-
Notifications
You must be signed in to change notification settings - Fork 252
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c0a8e26
commit 110d1c4
Showing
15 changed files
with
153 additions
and
99 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...gital-sales-rooms/app-deployment/index.md → ...ms/best-practices/app-deployment/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
nav: | ||
title: Frontend App Deployment | ||
position: 40 | ||
position: 10 | ||
|
||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
nav: | ||
title: Best practices | ||
position: 40 | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
74 changes: 74 additions & 0 deletions
74
products/digital-sales-rooms/installation/app-installation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
--- | ||
nav: | ||
title: Frontend app installation | ||
position: 30 | ||
|
||
--- | ||
|
||
# Frontend App Installation | ||
|
||
::: warning | ||
This template is built based on the Shopware Frontends framework, so it inherits from Shopware Frontends & Nuxt 3 concepts. | ||
::: | ||
|
||
## Init environment | ||
|
||
- Install pnpm with global scope | ||
``` | ||
npm install -g pnpm | ||
``` | ||
|
||
- From the Shopware root folder `<shopware-root-dir>`, go to the folder of *Digital Sales Rooms* templates. | ||
Check warning on line 21 in products/digital-sales-rooms/installation/app-installation.md GitHub Actions / Runner
|
||
``` | ||
cd ./custom/plugins/SwagDigitalSalesRooms/templates/dsr-frontends | ||
``` | ||
|
||
## Generate env file | ||
|
||
- Assume Shopware platform is running at `http://localhost:8000` & frontend app will run in `http://localhost:3000`. | ||
|
||
``` | ||
cp .env.template .env | ||
``` | ||
**NUXT_PUBLIC_SHOPWARE_DEV_STOREFRONT_URL**: This is current frontend app domain. E.g: `http://localhost:3000` | ||
|
||
**NUXT_PUBLIC_SHOPWARE_INSTANCE_URL**: This is default Shopware storefront domain. E.g: `http://localhost:8000` | ||
|
||
**NUXT_PUBLIC_SHOPWARE_ADMIN_API**: This is Shopware admin-api domain server. E.g: `http://localhost:8000/admin-api` | ||
|
||
**NUXT_PUBLIC_SHOPWARE_ENDPOINT**: This is the Shopware store-api domain server. E.g: `http://localhost:8000/store-api` | ||
|
||
**NUXT_PUBLIC_SHOPWARE_ACCESS_TOKEN**: This is the Shopware Access Token to connect to Shopware API. Head to sales channel you assign the *Digital Sales Rooms* domain, find the `API access` section, and copy the `API access key`. | ||
Check warning on line 41 in products/digital-sales-rooms/installation/app-installation.md GitHub Actions / Runner
|
||
|
||
**NUXT_PUBLIC_ALLOW_ANONYMOUS_MERCURE**: This is the flag for development only. When the value = 1, it means your app is running with unsecured Mercure. | ||
|
||
## Run frontend App | ||
|
||
For development, you can run the dev server by the following commands: | ||
|
||
- Install dependencies | ||
``` | ||
pnpm install | ||
``` | ||
|
||
- Run dev server | ||
``` | ||
pnpm dev | ||
``` | ||
Usually, port `3000` is the default port so that you can access the domain of the Frontend App `http://localhost:3000/` | ||
|
||
# Build frontend App | ||
|
||
For production, you can build code by the following commands: | ||
|
||
- Install dependencies | ||
``` | ||
pnpm install | ||
``` | ||
|
||
- Build | ||
``` | ||
pnpm build | ||
``` | ||
|
||
Following section guides you on 3rd parties setup procedure. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
nav: | ||
title: Installation | ||
position: 10 | ||
|
||
--- | ||
|
||
# Digital Sales Rooms Installation | ||
Check warning on line 8 in products/digital-sales-rooms/installation/index.md GitHub Actions / Runner
|
||
|
||
::: warning | ||
This section will show how to install *Digital Sales Rooms* plugin into the existing Shopware platform. It will not introduce how to install Shopware platform. | ||
::: | ||
|
||
This includes installation at admin and at template. Following sections gives you a detailed procedure of installation. |
48 changes: 0 additions & 48 deletions
48
products/digital-sales-rooms/local-installation/app-installation.md
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters