From e6b0a3b57ec27d226c1e74ea6c34e1c03127ea53 Mon Sep 17 00:00:00 2001 From: rittou Date: Tue, 6 Jan 2026 11:16:12 +0700 Subject: [PATCH 1/4] feat: Update sales agent deployment doc --- .../best-practices/app-deployment/aws.md | 29 ++++ .../app-deployment/cloudflare.md | 128 ++++++++++++++++++ .../hosted-with-ubuntu-server.md | 56 ++++++++ .../best-practices/app-deployment/index.md | 14 ++ products/sales-agent/best-practices/index.md | 6 + products/sales-agent/deployment.md | 21 --- products/sales-agent/installation.md | 6 + 7 files changed, 239 insertions(+), 21 deletions(-) create mode 100644 products/sales-agent/best-practices/app-deployment/aws.md create mode 100644 products/sales-agent/best-practices/app-deployment/cloudflare.md create mode 100644 products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md create mode 100644 products/sales-agent/best-practices/app-deployment/index.md create mode 100644 products/sales-agent/best-practices/index.md delete mode 100644 products/sales-agent/deployment.md diff --git a/products/sales-agent/best-practices/app-deployment/aws.md b/products/sales-agent/best-practices/app-deployment/aws.md new file mode 100644 index 0000000000..48bed11d78 --- /dev/null +++ b/products/sales-agent/best-practices/app-deployment/aws.md @@ -0,0 +1,29 @@ +--- +nav: + title: AWS + position: 20 + +--- + +# Deploy with AWS Amplify + +In this chapter, you will learn how to deploy the frontend source code to [AWS Amplify](https://aws.amazon.com/amplify/). + +## Prerequisites + +* Register an AWS account. +* Clone the frontend source code and push it to your GitHub repository. +* Push source code to your Git repository. + +## Deploy + +* Login to the AWS Amplify Hosting Console. +* Create a new app in AWS Amplify. +* Select and authorize access to your Git repository provider and select the main branch (it will auto deploy when there are some changes in the main branch). +* Choose a name for your app and make sure build settings are auto-detected. +* Set Environment variables which is declared in `.env.template` under the Advanced Settings section. +* Confirm the configuration and click on "Save and Deploy". + +## Custom domain + +After deploying your code to AWS Amplify, you may wish to point custom domains (or subdomains) to your site. AWS has an [instruction](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html). diff --git a/products/sales-agent/best-practices/app-deployment/cloudflare.md b/products/sales-agent/best-practices/app-deployment/cloudflare.md new file mode 100644 index 0000000000..0daf4c47c5 --- /dev/null +++ b/products/sales-agent/best-practices/app-deployment/cloudflare.md @@ -0,0 +1,128 @@ +--- +nav: + title: Cloudflare + position: 30 + +--- + +# Deploy with Cloudflare + +In this chapter you will learn how to deploy the frontend source code to [Cloudflare Pages](https://pages.cloudflare.com/). + +## Prerequisites + +* Register a Cloudflare account. +* Clone the frontend source code and push to your GitHub repository. + +## Deploy from local machine + +* Due to this [issue](https://github.com/nuxt/nuxt/issues/28248), just make sure your `.npmrc` file has + +```bash +shamefully-hoist=true +strict-peer-dependencies=false +``` + +* Install Wrangler + +```bash +pnpm install wrangler --save-dev +``` + +* Make sure the Frontend app has already [generated .env file](../../installation.md#create-a-env-file) +* Build your project for Cloudflare Pages: + +```bash +npx nuxi build --preset=cloudflare_pages +``` + +* Then deploy. However, for the first time, it will ask you to create a project: + +```bash +wrangler pages deploy dist/ +``` + +## Automation with GitHub Actions + +### Setup GitHub Secrets & variables + +* In GitHub Secrets, add `CLOUDFLARE_API_TOKEN` with API token value. + * [Create an API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) in the Cloudflare dashboard with the "Cloudflare Pages — Edit" permission. +* In GitHub environment variables, create new environment named `production` and fill it with all environment variables in `.env.template`. + * Besides `production`, we can add new values for the same variable names in multiple environments such as `development`, `staging`. + +### Setup pipeline + +To trigger the deployment automatically, we can attach the GitHub Actions. + +* Create a `.github/workflows/publish.yml` file in your repository with below sample content. + +::: warning +Please note that this pipeline is just a sample. There are some points need to update for specific purpose +::: + +```yml +on: + push: + # Specify the pipeline trigger + branches: + - main + +jobs: + publish: + runs-on: ubuntu-latest + permissions: + contents: read + deployments: write + name: Cloudflare Pages Deployment + # Specify the environment name + environment: production + steps: + - name: Checkout + uses: actions/checkout@v3 + + - uses: pnpm/action-setup@v4 + name: Install pnpm + with: + version: 8 + run_install: false + + - name: Install dependencies + run: | + pnpm install + + - name: Build env file + run: | + touch .env + echo COMPANY_NAME=${{ vars.COMPANY_NAME }} >> .env + echo ORIGIN=${{ vars.ORIGIN }} >> .env + echo REDIS_CACHE=${{ vars.REDIS_CACHE }} >> .env + echo REDIS_HOST=${{ vars.REDIS_HOST }} >> .env + echo REDIS_PORT=${{ vars.REDIS_PORT }} >> .env + echo REDIS_PASSWORD=${{ vars.REDIS_PASSWORD }} >> .env + echo REDIS_TLS=${{ vars.REDIS_TLS }} >> .env + echo APP_NAME=${{ vars.REDIS_TLS }} >> .env + echo APP_SECRET=${{ vars.REDIS_TLS }} >> .env + echo DATABASE_URL=${{ vars.REDIS_TLS }} >> .env + cat .env + + - name: Build code + run: | + npx nuxi build --preset=cloudflare_pages + + - name: Publish to Cloudflare Pages + uses: cloudflare/pages-action@v1.5.0 + with: + apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} + accountId: YOUR_ACCOUNT_ID + projectName: YOUR_PROJECT_NAME + directory: dist + wranglerVersion: '3' +``` + +* Replace `YOUR_ACCOUNT_ID` with your account ID. Get it from the dashboard URL. E.g: `https://dash.cloudflare.com//pages`. +* Replace `YOUR_PROJECT_NAME` with the appropriate value. + +## Custom domain + +When deploying your Pages project, you may wish to point custom domains (or subdomains) to your site. Cloudflare has an [instruction](https://developers.cloudflare.com/pages/configuration/custom-domains/). diff --git a/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md b/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md new file mode 100644 index 0000000000..e407690e8a --- /dev/null +++ b/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md @@ -0,0 +1,56 @@ +--- +nav: + title: Ubuntu Server with PM2 + position: 10 + +--- + +# Deploy with Ubuntu Server with PM2 + +This guide will walk you through the steps to deploy Sales Agent frontend web application to an Ubuntu server using [PM2](https://nuxt.com/docs/getting-started/deployment#pm2), a process manager for Node.js applications. PM2 will help you keep your app running in the background, restart it automatically when it crashes, and manage logs for easier troubleshooting. + +## Prerequisites + +* **Ubuntu Server**: This guide assumes you have an Ubuntu server running, and you can access it via SSH. +* **Node.js & npm**: Make sure Node.js and npm (Node package manager) are installed on your server. +* **PM2**: PM2 should be installed globally. + +```bash +npm install -g pm2 +``` + +* **pnpm** + +```bash +npm install -g pnpm +``` + +* **Frontend Application**: Clone the frontend source code and push to your GitHub repository. + +## Build code + +* Please follow instructions here to [build code for production](../../installation.md#setup-app-server) + +## Start the Application with PM2 + +Now that your app is built, create a file named `ecosystem.config.cjs` in the root of your project with the following content. Ensure that the script path points to your app's build output directory (e.g., `.output/server/index.mjs` for Nuxt 3) + +```js +module.exports = { + apps: [ + { + name: 'DSRNuxtApp', + port: '3000', + exec_mode: 'cluster', + instances: 'max', + script: './.output/server/index.mjs' + } + ] +} +``` + +Once saved, you can start the app with: + +```bash +pm2 start ecosystem.config.cjs +``` diff --git a/products/sales-agent/best-practices/app-deployment/index.md b/products/sales-agent/best-practices/app-deployment/index.md new file mode 100644 index 0000000000..388421d629 --- /dev/null +++ b/products/sales-agent/best-practices/app-deployment/index.md @@ -0,0 +1,14 @@ +--- +nav: + title: Frontend App Deployment + position: 10 + +--- + +# Frontend App Deployment + +According to [Shopware Frontends deployment document](https://frontends.shopware.com/best-practices/deployment.html), all the templates which were generated by Shopware Frontends can be deployed in multiple ways, depending on the setup you are using. Most likely you will be using either a static hosting service or a server with a Node.js runtime. + +You may find the different approaches as described in [Nuxt instruction](https://nuxt.com/deploy). + +Alternatively, we will show some best practices of *Sales Agent* frontend app deployment. diff --git a/products/sales-agent/best-practices/index.md b/products/sales-agent/best-practices/index.md new file mode 100644 index 0000000000..5c0826a6df --- /dev/null +++ b/products/sales-agent/best-practices/index.md @@ -0,0 +1,6 @@ +--- +nav: + title: Best practices + position: 40 + +--- diff --git a/products/sales-agent/deployment.md b/products/sales-agent/deployment.md deleted file mode 100644 index d07ac8e472..0000000000 --- a/products/sales-agent/deployment.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -nav: -title: Deployment -position: 40 - ---- - -# Deployment - -For general information about running a Nuxt application in production, refer to the [official docs](https://nuxt.com/docs/getting-started/deployment). - -In addition, you still need to setup the Database and cache layer for production mode. - -## Nuxt production build - -To build and start the project in production mode: - -```bash -pnpm build -pnpm start -``` diff --git a/products/sales-agent/installation.md b/products/sales-agent/installation.md index bc810e2d9a..edec30d0ac 100644 --- a/products/sales-agent/installation.md +++ b/products/sales-agent/installation.md @@ -62,6 +62,12 @@ Choose one of the following commands based on your needs: pnpm dev ``` +### Build code for Production + +```shell +pnpm build +``` + ## Connect App to Shopware Instance * Build zip From a2434e0292a7806b8a891c6ac2a625abe518da9e Mon Sep 17 00:00:00 2001 From: rittou Date: Wed, 7 Jan 2026 21:35:32 +0700 Subject: [PATCH 2/4] feat: Resolve threads --- .../best-practices/app-deployment/aws.md | 22 ++++----- .../app-deployment/cloudflare.md | 46 +++++++++---------- .../hosted-with-ubuntu-server.md | 33 +++++++------ .../best-practices/app-deployment/index.md | 3 +- products/sales-agent/best-practices/index.md | 1 - products/sales-agent/installation.md | 21 ++++----- 6 files changed, 59 insertions(+), 67 deletions(-) diff --git a/products/sales-agent/best-practices/app-deployment/aws.md b/products/sales-agent/best-practices/app-deployment/aws.md index 48bed11d78..a4273b9e79 100644 --- a/products/sales-agent/best-practices/app-deployment/aws.md +++ b/products/sales-agent/best-practices/app-deployment/aws.md @@ -1,8 +1,7 @@ --- nav: - title: AWS - position: 20 - + title: AWS + position: 20 --- # Deploy with AWS Amplify @@ -11,18 +10,17 @@ In this chapter, you will learn how to deploy the frontend source code to [AWS A ## Prerequisites -* Register an AWS account. -* Clone the frontend source code and push it to your GitHub repository. -* Push source code to your Git repository. +- Register an AWS account. +- Clone the frontend source code and push it to your Git repository (for example, GitHub). ## Deploy -* Login to the AWS Amplify Hosting Console. -* Create a new app in AWS Amplify. -* Select and authorize access to your Git repository provider and select the main branch (it will auto deploy when there are some changes in the main branch). -* Choose a name for your app and make sure build settings are auto-detected. -* Set Environment variables which is declared in `.env.template` under the Advanced Settings section. -* Confirm the configuration and click on "Save and Deploy". +- Login to the AWS Amplify Hosting Console. +- Create a new app in AWS Amplify. +- Select and authorize access to your Git repository provider and select the main branch (it will auto deploy when there are some changes in the main branch). +- Choose a name for your app and make sure build settings are auto-detected. +- Set Environment variables which are declared in `.env.template` under the Advanced Settings section. +- Confirm the configuration and click on "Save and Deploy". ## Custom domain diff --git a/products/sales-agent/best-practices/app-deployment/cloudflare.md b/products/sales-agent/best-practices/app-deployment/cloudflare.md index 0daf4c47c5..f43fe7cc8b 100644 --- a/products/sales-agent/best-practices/app-deployment/cloudflare.md +++ b/products/sales-agent/best-practices/app-deployment/cloudflare.md @@ -1,8 +1,7 @@ --- nav: - title: Cloudflare - position: 30 - + title: Cloudflare + position: 30 --- # Deploy with Cloudflare @@ -11,32 +10,32 @@ In this chapter you will learn how to deploy the frontend source code to [Cloudf ## Prerequisites -* Register a Cloudflare account. -* Clone the frontend source code and push to your GitHub repository. +- Register a Cloudflare account. +- Clone the frontend source code and push to your GitHub repository. ## Deploy from local machine -* Due to this [issue](https://github.com/nuxt/nuxt/issues/28248), just make sure your `.npmrc` file has +- Due to this [issue](https://github.com/nuxt/nuxt/issues/28248), just make sure your `.npmrc` file has ```bash shamefully-hoist=true strict-peer-dependencies=false ``` -* Install Wrangler +- Install Wrangler ```bash pnpm install wrangler --save-dev ``` -* Make sure the Frontend app has already [generated .env file](../../installation.md#create-a-env-file) -* Build your project for Cloudflare Pages: +- Make sure the Frontend app has already [generated .env file](../../installation.md#create-a-env-file) +- Build your project for Cloudflare Pages: ```bash npx nuxi build --preset=cloudflare_pages ``` -* Then deploy. However, for the first time, it will ask you to create a project: +- Then deploy. However, for the first time, it will ask you to create a project: ```bash wrangler pages deploy dist/ @@ -46,16 +45,16 @@ wrangler pages deploy dist/ ### Setup GitHub Secrets & variables -* In GitHub Secrets, add `CLOUDFLARE_API_TOKEN` with API token value. - * [Create an API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) in the Cloudflare dashboard with the "Cloudflare Pages — Edit" permission. -* In GitHub environment variables, create new environment named `production` and fill it with all environment variables in `.env.template`. - * Besides `production`, we can add new values for the same variable names in multiple environments such as `development`, `staging`. +- In GitHub Secrets, add `CLOUDFLARE_API_TOKEN` with API token value. + - [Create an API token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) in the Cloudflare dashboard with the "Cloudflare Pages — Edit" permission. +- In GitHub environment variables, create new environment named `production` and fill it with all environment variables in `.env.template`. + - Besides `production`, we can add new values for the same variable names in multiple environments such as `development`, `staging`. ### Setup pipeline To trigger the deployment automatically, we can attach the GitHub Actions. -* Create a `.github/workflows/publish.yml` file in your repository with below sample content. +- Create a `.github/workflows/publish.yml` file in your repository with below sample content. ::: warning Please note that this pipeline is just a sample. There are some points need to update for specific purpose @@ -64,8 +63,8 @@ Please note that this pipeline is just a sample. There are some points need to u ```yml on: push: - # Specify the pipeline trigger - branches: + # Specify the pipeline trigger + branches: - main jobs: @@ -101,10 +100,9 @@ jobs: echo REDIS_PORT=${{ vars.REDIS_PORT }} >> .env echo REDIS_PASSWORD=${{ vars.REDIS_PASSWORD }} >> .env echo REDIS_TLS=${{ vars.REDIS_TLS }} >> .env - echo APP_NAME=${{ vars.REDIS_TLS }} >> .env - echo APP_SECRET=${{ vars.REDIS_TLS }} >> .env - echo DATABASE_URL=${{ vars.REDIS_TLS }} >> .env - cat .env + echo APP_NAME=${{ vars.APP_NAME }} >> .env + echo APP_SECRET=${{ vars.APP_SECRET }} >> .env + echo DATABASE_URL=${{ vars.DATABASE_URL }} >> .env - name: Build code run: | @@ -117,11 +115,11 @@ jobs: accountId: YOUR_ACCOUNT_ID projectName: YOUR_PROJECT_NAME directory: dist - wranglerVersion: '3' + wranglerVersion: "3" ``` -* Replace `YOUR_ACCOUNT_ID` with your account ID. Get it from the dashboard URL. E.g: `https://dash.cloudflare.com//pages`. -* Replace `YOUR_PROJECT_NAME` with the appropriate value. +- Replace `YOUR_ACCOUNT_ID` with your account ID. Get it from the dashboard URL. E.g: `https://dash.cloudflare.com//pages`. +- Replace `YOUR_PROJECT_NAME` with the appropriate value. ## Custom domain diff --git a/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md b/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md index e407690e8a..c581d51e9a 100644 --- a/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md +++ b/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md @@ -1,8 +1,7 @@ --- nav: - title: Ubuntu Server with PM2 - position: 10 - + title: Ubuntu Server with PM2 + position: 10 --- # Deploy with Ubuntu Server with PM2 @@ -11,25 +10,25 @@ This guide will walk you through the steps to deploy Sales Agent frontend web ap ## Prerequisites -* **Ubuntu Server**: This guide assumes you have an Ubuntu server running, and you can access it via SSH. -* **Node.js & npm**: Make sure Node.js and npm (Node package manager) are installed on your server. -* **PM2**: PM2 should be installed globally. +- **Ubuntu Server**: This guide assumes you have an Ubuntu server running, and you can access it via SSH. +- **Node.js & npm**: Make sure Node.js and npm (Node package manager) are installed on your server. +- **PM2**: PM2 should be installed globally. ```bash npm install -g pm2 ``` -* **pnpm** +- **pnpm** ```bash npm install -g pnpm ``` -* **Frontend Application**: Clone the frontend source code and push to your GitHub repository. +- **Frontend Application**: Clone the frontend source code and push to your GitHub repository. ## Build code -* Please follow instructions here to [build code for production](../../installation.md#setup-app-server) +- Please follow instructions here to [set up all necessary things and build the code](../../installation.md#setup-app-server) ## Start the Application with PM2 @@ -39,14 +38,14 @@ Now that your app is built, create a file named `ecosystem.config.cjs` in the ro module.exports = { apps: [ { - name: 'DSRNuxtApp', - port: '3000', - exec_mode: 'cluster', - instances: 'max', - script: './.output/server/index.mjs' - } - ] -} + name: "DSRNuxtApp", + port: "3000", + exec_mode: "cluster", + instances: "max", + script: "./.output/server/index.mjs", + }, + ], +}; ``` Once saved, you can start the app with: diff --git a/products/sales-agent/best-practices/app-deployment/index.md b/products/sales-agent/best-practices/app-deployment/index.md index 388421d629..baa1929111 100644 --- a/products/sales-agent/best-practices/app-deployment/index.md +++ b/products/sales-agent/best-practices/app-deployment/index.md @@ -2,7 +2,6 @@ nav: title: Frontend App Deployment position: 10 - --- # Frontend App Deployment @@ -11,4 +10,4 @@ According to [Shopware Frontends deployment document](https://frontends.shopware You may find the different approaches as described in [Nuxt instruction](https://nuxt.com/deploy). -Alternatively, we will show some best practices of *Sales Agent* frontend app deployment. +Alternatively, we will show some best practices of _Sales Agent_ frontend app deployment. diff --git a/products/sales-agent/best-practices/index.md b/products/sales-agent/best-practices/index.md index 5c0826a6df..491ab04429 100644 --- a/products/sales-agent/best-practices/index.md +++ b/products/sales-agent/best-practices/index.md @@ -2,5 +2,4 @@ nav: title: Best practices position: 40 - --- diff --git a/products/sales-agent/installation.md b/products/sales-agent/installation.md index edec30d0ac..59d3e0d1e2 100644 --- a/products/sales-agent/installation.md +++ b/products/sales-agent/installation.md @@ -1,8 +1,7 @@ --- nav: - title: Local installation - position: 20 - + title: Local installation + position: 20 --- # Local installation @@ -11,9 +10,9 @@ nav: Obtain all the credentials to connect to the following services: -* Database (MySQL). +- Database (MySQL). -* Cache layer (Redis). +- Cache layer (Redis). ## Setup App Server @@ -26,7 +25,7 @@ cd swagsalesagent ### Create a `.env` File -* Use the provided `.env.template` file as an example. +- Use the provided `.env.template` file as an example. ```shell cp .env.template .env @@ -44,13 +43,13 @@ pnpm install --frozen-lockfile --prefer-offline Choose one of the following commands based on your needs: -* Execute existing migrations without creating new files: +- Execute existing migrations without creating new files: ```bash pnpm db:migration:deploy ``` -* Execute & create new migration files if there are schema changes: +- Execute & create new migration files if there are schema changes: ```bash pnpm db:migration:dev @@ -70,14 +69,14 @@ pnpm build ## Connect App to Shopware Instance -* Build zip +- Build zip ```bash pnpm app:build ``` -* Upload zip from `bundle/swagsalesagent.zip` into Shopware Extensions. +- Upload zip from `bundle/swagsalesagent.zip` into Shopware Extensions. -* Verify the Installed App: after installation, you should see the Sales Agent menu item appear in the Settings. +- Verify the Installed App: after installation, you should see the Sales Agent menu item appear in the Settings. ![ ](../../assets/sales-agent-item.png) From 7551910f4c7c994cd0f13b9bb9ea742451c95441 Mon Sep 17 00:00:00 2001 From: rittou Date: Thu, 8 Jan 2026 09:56:54 +0700 Subject: [PATCH 3/4] feat: Resolve threads --- .../best-practices/app-deployment/hosted-with-ubuntu-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md b/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md index c581d51e9a..dcf29d35f5 100644 --- a/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md +++ b/products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.md @@ -38,7 +38,7 @@ Now that your app is built, create a file named `ecosystem.config.cjs` in the ro module.exports = { apps: [ { - name: "DSRNuxtApp", + name: "SalesAgentApp", port: "3000", exec_mode: "cluster", instances: "max", From c7efa0829d1e579b778e22dc6b9a2d19bb3f73d0 Mon Sep 17 00:00:00 2001 From: Micha Date: Thu, 8 Jan 2026 15:40:38 +0100 Subject: [PATCH 4/4] chore/add-redirect-small-fixes --- .gitbook.yaml | 1 + .../sales-agent/best-practices/app-deployment/aws.md | 2 +- .../best-practices/app-deployment/cloudflare.md | 10 +++++----- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.gitbook.yaml b/.gitbook.yaml index d925e661c7..81ec21a937 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -90,3 +90,4 @@ redirects: products/extensions/migration-assistant/concept.html: products/extensions/migration-assistant/concept/index.html products/extensions/migration-assistant/guides.html: products/extensions/migration-assistant/guides/index.html products/cli/project-commands/project-config-sync.html: resources/tooling/fixture-bundle/index.html + products/sales-agent/deployment.html: products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.html \ No newline at end of file diff --git a/products/sales-agent/best-practices/app-deployment/aws.md b/products/sales-agent/best-practices/app-deployment/aws.md index a4273b9e79..9c60f55aac 100644 --- a/products/sales-agent/best-practices/app-deployment/aws.md +++ b/products/sales-agent/best-practices/app-deployment/aws.md @@ -17,7 +17,7 @@ In this chapter, you will learn how to deploy the frontend source code to [AWS A - Login to the AWS Amplify Hosting Console. - Create a new app in AWS Amplify. -- Select and authorize access to your Git repository provider and select the main branch (it will auto deploy when there are some changes in the main branch). +- Select and authorize access to your Git repository provider and select the main branch (it will auto-deploy when there are some changes in the main branch). - Choose a name for your app and make sure build settings are auto-detected. - Set Environment variables which are declared in `.env.template` under the Advanced Settings section. - Confirm the configuration and click on "Save and Deploy". diff --git a/products/sales-agent/best-practices/app-deployment/cloudflare.md b/products/sales-agent/best-practices/app-deployment/cloudflare.md index f43fe7cc8b..085a111d0b 100644 --- a/products/sales-agent/best-practices/app-deployment/cloudflare.md +++ b/products/sales-agent/best-practices/app-deployment/cloudflare.md @@ -13,9 +13,9 @@ In this chapter you will learn how to deploy the frontend source code to [Cloudf - Register a Cloudflare account. - Clone the frontend source code and push to your GitHub repository. -## Deploy from local machine +## Deploy from a local machine -- Due to this [issue](https://github.com/nuxt/nuxt/issues/28248), just make sure your `.npmrc` file has +- Due to this [issue](https://github.com/nuxt/nuxt/issues/28248), just make sure your `.npmrc` file has the following content: ```bash shamefully-hoist=true @@ -28,7 +28,7 @@ strict-peer-dependencies=false pnpm install wrangler --save-dev ``` -- Make sure the Frontend app has already [generated .env file](../../installation.md#create-a-env-file) +- Make sure the Frontend app has already [generated an .env file](../../installation.md#create-a-env-file) - Build your project for Cloudflare Pages: ```bash @@ -54,10 +54,10 @@ wrangler pages deploy dist/ To trigger the deployment automatically, we can attach the GitHub Actions. -- Create a `.github/workflows/publish.yml` file in your repository with below sample content. +- Create a `.github/workflows/publish.yml` file in your repository with the below sample content. ::: warning -Please note that this pipeline is just a sample. There are some points need to update for specific purpose +Please note that this pipeline is just a sample. There are some points need to update for a specific purpose ::: ```yml