Merge branch 'main' into fix/readonly-address-error

.github/actions/setup/action.yml

@@ -18,23 +18,8 @@ runs:
         cache: 'yarn'
         registry-url: 'https://npm.pkg.github.com'
 
-    - name: Set yarn version
-      run: |
-        yarn set version stable
-        yarn set version 3.6.4
-      shell: bash
-
-    - name: Setup .yarnrc.yml
-      run: |
-        yarn config set nodeLinker node-modules
-        yarn config set npmScopes.plentymarkets.npmRegistryServer "https://npm.pkg.github.com"
-        yarn config set npmScopes.plentymarkets.npmAlwaysAuth true
-        yarn config set npmScopes.plentymarkets.npmAuthToken $NODE_AUTH_TOKEN
-        yarn plugin import workspace-tools
+    - name: Setup yarn
+      run: chmod +x ${{ github.workspace }}/yarn.sh && ${{ github.workspace }}/yarn.sh
       shell: bash
       env:
-        NODE_AUTH_TOKEN: ${{ inputs.npm-auth-token }}
-
-    - name: Install Dependencies
-      run: yarn --frozen-lockfile
-      shell: bash
+        NPM_AUTH_TOKEN: ${{ inputs.npm-auth-token }}

README.md

@@ -17,41 +17,47 @@ Welcome to the plentysystems integration for Alokai.
 
 This section describes how to run the project locally with the preconfigured demo system.
 
-### Prerequisites
-
-- `Node.js` 20+
-- `Yarn` 3
-- [Personal Access Token](https://github.com/settings/tokens/new) with the scope **read:packages**
-
-Download Node.js from the [official website](https://nodejs.org/) or use [nvm](https://github.com/nvm-sh/nvm) to switch to a compatible version. For installation instructions for Yarn, refer to the [Yarn documentation](https://yarnpkg.com/getting-started/install).
-
-### Repository fork
+### Fork repository
 
 We recommend working with a fork of this repository. A fork allows you to easily incorporate updates from this boilerplate into your own codebase.
 
 1. [Create a fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
 2. [Clone the forked repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
 
-### Authentication
+### Create authentication token
+
+This project queries data from plentysystems by using other NPM packages as middleware. These packages are published on the GitHub registry. To download packages from GitHub's registry, you have to authenticate.
+
+To enable authentication, create a [Personal Access Token](https://github.com/settings/tokens/new) (PAT) with the scope **read:packages**.
+
+### Set up environment
+
+Create an environment file under `apps/web/.env`. The minimum required configuration includes your PAT, the [API endpoint](https://pwa-docs.plentymarkets.com/guide/how-to/middleware#api-endpoint) of your PlentyONE system and the corresponding [API security token](https://pwa-docs.plentymarkets.com/guide/how-to/middleware#api-security-token):
+
+```properties
+# apps/web/.env
 
-This project queries data from plentysystems by using other NPM packages as middleware. These packages are published on the GitHub registry. To download packages from GitHub's registry, you have to authenticate. To enable authentication, carry out the following steps:
+NPM_AUTH_TOKEN=
+API_ENDPOINT=
+API_SECURITY_TOKEN=
+```
 
-1. In the root directory, create a new file called `.yarnrc.yml`.
-2. Copy the contents of `.yarnrc.yml.example` to `.yarnrc.yml`.
-3. In `.yarnrc.yml`, replace `<TOKEN>` with the Personal Access Token you created earlier.
+Download Node.js from the [official website](https://nodejs.org/). We recommend using [nvm](https://github.com/nvm-sh/nvm) to easily stay compatible with new versions. Then install all dependencies using Yarn.
 
-Git doesn't track `.yarnrc.yml`, so you don't have to worry about exposing your token.
+```bash
+# installs nvm (Node Version Manager)
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
 
-### Setup environment
+# downloads and installs Node.js according to the project version in .nvmrc
+nvm install
 
-1. Add your [API endpoint](https://pwa-docs.plentymarkets.com/guide/how-to/middleware#api-endpoint)
-2. Add your [API security token](https://pwa-docs.plentymarkets.com/guide/how-to/middleware#api-security-token)
+# downloads and installs Yarn according to the project version, and downloads, installs, and builds all dependencies
+npm run setup:unix
+```
 
-### Starting the app
+### Start the app
 
-1. Open the repository in your command line interface.
-2. Run `yarn` to install all dependencies.
-3. Run `yarn dev` to start the development server. The app will be served with hot reload at [localhost:3000](http://localhost:3000/).
+Run `yarn dev` to start the development server. The app will be served with hot reload at [localhost:3000](http://localhost:3000/).
 
 ## Resources
 

apps/web/.env.example

@@ -1,3 +1,4 @@
+NPM_AUTH_TOKEN=
 API_ENDPOINT=
 API_SECURITY_TOKEN=
 TURNSTILESITEKEY="0x4AAAAAAANx3aXDh7UR35x0"

docs/changelog/changelog_en.md

@@ -44,6 +44,21 @@ The **Upload** action now supports deploying the PWA to different environments:
 
 Each client supports two PWA instances. With this change, you can designate the live instance as the production environment and the preview instance as the staging environment. The production environment uses the GitHub Actions Secret `URL_ENDPOINT_TOKEN`; the staging environment uses the GitHub Actions Secret `URL_ENDPOINT_TOKEN_STAGING`.
 
+### NPM Authentication Token
+
+Instead of creating a `.yarnrc.yml` file manually, you can now use one of the following scripts depending on your operating system:
+
+- Linux/MacOS: `yarn.sh` | `npm run setup:unix`
+- Windows: `yarn.ps1` | `npm run setup:windows`
+
+To run the script, you have to add your GitHub Token with `read:packages` permissions to the environment.
+
+```properties
+# apps/web/.env
+
+NPM_AUTH_TOKEN="<TOKEN>"
+```
+
 ### 🩹 Fixed
 
 - Addressed a scenario where deleting the checkout address as a guest triggered an unknown error.

package.json

@@ -9,7 +9,8 @@
   "scripts": {
     "prepare": "is-ci || husky install",
     "update:sdk": "yarn up @plentymarkets/shop-api",
-    "setup": "yarn && yarn build && yarn dev",
+    "setup:unix": "chmod +x yarn.sh && ./yarn.sh && yarn build",
+    "setup:windows": "powershell -Command \"Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process; ./yarn.ps1\" && yarn build",
     "turbo:disable-telemetry": "turbo telemetry disable",
     "build": "yarn turbo:disable-telemetry && turbo run build",
     "build:analyze": "yarn turbo:disable-telemetry && turbo run build:analyze",
@@ -78,7 +79,7 @@
     "yarn": ">=3.6.1",
     "node": ">=20.0.0"
   },
-  "packageManager": "yarn@3.6.4",
+  "packageManager": "yarn@4.5.3",
   "config": {
     "commitizen": {
       "path": "cz-conventional-changelog",