From 36332e108e1cddafc8310c67de5cdf55b9508bcf Mon Sep 17 00:00:00 2001
From: rostislav <rostilosfl@gmail.com>
Date: Sun, 12 May 2024 18:39:11 +0300
Subject: [PATCH 1/3] Documentation on the integration module for Magento 2

---
 docs/magento2.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 docs/magento2.md

diff --git a/docs/magento2.md b/docs/magento2.md
new file mode 100644
index 00000000..37b3bedd
--- /dev/null
+++ b/docs/magento2.md
@@ -0,0 +1,68 @@
+---
+title: Magento 2
+---
+
+To integrate the partytown library functionality into your Magento 2 project, you can use the integration module for Magento2 :
+<a href="https://github.com/rostilos/perspective-partytown">Module for integrating BuilderIO/partytown library functionality into Magento 2 project</a>
+
+## Requirements
+<ul>
+ <li>PHP 8.1 or higher</li>
+ <li>Magento 2.4.4 or higher</li>
+ <li>Node.js v16 or higher</li>
+ <li>configured https for the domain ( for correct work of service wokers )</li>
+ <li>Optional : configured reverse proxy for correct loading of some scripts ( see below )</li>
+</ul
+
+
+## Install
+
+```bash
+composer config repositories.perspective-magento2-partytown git git@github.com:rostilos/perspective-partytown.git
+composer require perspective/magento2-partytown dev-master
+php bin/magento setup:upgrade
+bin/magento setup:di:compile
+php bin/magento setup:static-content:deploy
+```
+Next, clear all the cache
+
+## Updating partytown lib npm packages
+
+The library files provided by the npm package @builder.io/partytown are already added to the module files, but in case you want to update them, it is recommended to do the following :
+
+```bash
+cd <magento-root>/vendor/perspective/magento2-partytown
+npm install ( node v16+ required )
+npm run partytown
+````
+
+## Configure
+
+In order for scripts to be loaded and executed in a separate thread of the webworker - you need to set the appropriate type ( text/partytown ) when connecting them. Using the example of GMT :
+
+```html
+<!-- Google Tag Manager -->
+<script type="text/partytown">(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','GTM-XXXXXXXX');</script>
+<!-- End Google Tag Manager -->
+```
+
+Configuration of the module is managed through the admin panel, where you can select the list of available analytics services that will be allocated for execution in the webworker, as well as specify other configurations that affect the functionality of the library
+
+You can find the configurations at the following path :
+
+Stores -> Configuration -> Perspective -> Partytown
+
+## Optional: reverse-proxying scripts
+
+Given the peculiarities of the partytown library, you may encounter CORS errors when using certain scripts whose resources do not give the required headers. To avoid this, use reverse-proxying, the peculiarities and possible implementations are described here:
+<a href="https://partytown.builder.io/proxying-requests">Proxying Requests</a>
+
+You can also try using a self-hosted reverse-proxy solution 
+( see example here <a href="https://github.com/rostilos/perspective-partytown/blob/2.0.0-alpha/docs/reverse-proxy.md">Node.js reverse-proxy example for partytown library</a> ).
+
+## Troubleshooting
+If you encounter errors when using the integration module for magento2 - you can also create an issue in the <a href="https://github.com/rostilos/perspective-partytown">source repository</a>
\ No newline at end of file

From 79a8c66a71b89f3264832f2bd4d02cd1e89d0e95 Mon Sep 17 00:00:00 2001
From: rostislav <rostilosfl@gmail.com>
Date: Sun, 12 May 2024 18:42:17 +0300
Subject: [PATCH 2/3] magento2 docs, minor fixes

---
 docs/magento2.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/magento2.md b/docs/magento2.md
index 37b3bedd..d8e259a4 100644
--- a/docs/magento2.md
+++ b/docs/magento2.md
@@ -65,4 +65,4 @@ You can also try using a self-hosted reverse-proxy solution
 ( see example here <a href="https://github.com/rostilos/perspective-partytown/blob/2.0.0-alpha/docs/reverse-proxy.md">Node.js reverse-proxy example for partytown library</a> ).
 
 ## Troubleshooting
-If you encounter errors when using the integration module for magento2 - you can also create an issue in the <a href="https://github.com/rostilos/perspective-partytown">source repository</a>
\ No newline at end of file
+If you encounter errors when using the integration module for Magento 2 - you can also create an issue in the <a href="https://github.com/rostilos/perspective-partytown">source repository</a>
\ No newline at end of file

From 6e64b48fe099610df9ae09f3c8f263c8558b9650 Mon Sep 17 00:00:00 2001
From: rostislav <rostilosfl@gmail.com>
Date: Sun, 12 May 2024 23:26:47 +0300
Subject: [PATCH 3/3] added link to reverse-proxy example for warden

---
 docs/magento2.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/magento2.md b/docs/magento2.md
index d8e259a4..6535301b 100644
--- a/docs/magento2.md
+++ b/docs/magento2.md
@@ -62,7 +62,7 @@ Given the peculiarities of the partytown library, you may encounter CORS errors
 <a href="https://partytown.builder.io/proxying-requests">Proxying Requests</a>
 
 You can also try using a self-hosted reverse-proxy solution 
-( see example here <a href="https://github.com/rostilos/perspective-partytown/blob/2.0.0-alpha/docs/reverse-proxy.md">Node.js reverse-proxy example for partytown library</a> ).
+( see example here <a href="https://github.com/rostilos/perspective-partytown/blob/2.0.0-alpha/docs/reverse-proxy.md">Node.js reverse-proxy example for partytown library</a> and here <a href="https://github.com/rostilos/perspective-partytown/blob/2.0.0-alpha/docs/reverse-proxy.md">Nginx reverse-proxy example for partytown library ( for warden ) </a>  ).
 
 ## Troubleshooting
 If you encounter errors when using the integration module for Magento 2 - you can also create an issue in the <a href="https://github.com/rostilos/perspective-partytown">source repository</a>
\ No newline at end of file