PWA Metapackage for Magento Open Source Extensions

Welcome to PWA metapackage for Magento Open Source extensions. As a metapackage for Magento Open Source, this repo enables PWA extension developers to add any additional Magento Open Source features they need to support their PWA modules.

Current Modules

Magento_ContactGraphQlPwa (magento/module-contact-graph-ql-pwa) — Provides GraphQl functionality for the contact-us form.
Magento_NewsletterGraphQlPwa (magento/module-newsletter-graph-ql-pwa) — Provides additional GraphQl functionality for the newsletter subscriptions in PWA.

Development setup

To setup and develop your PWA extension modules locally, use the following instructions:

Installation as a git-based composer package

Clone and/or navigate to your magento2 git repository and check out the latest develop branch, e.g. 2.4-develop. You may also check out and use any 2.4 release tags.
```
git clone git@github.com:magento/magento2.git
cd magento2
```
Create an ext directory within the root of your magento2 project:
```
mkdir ext
```

Clone the magento2-pwa repository into your vendor directory name:

git clone git@github.com:magento-commerce/magento2-pwa.git ext/magento/magento2-pwa

Update the magento2/composer.json settings to create a better development workflow for your extension modules:
- Update the minimum-stability for packages to dev. This allows for the installation of development modules:
```
composer config minimum-stability dev
```
- To work with stable packages, ensure that the prefer-stable property is true. This property should already be included in the composer.json file, right above the minimum-stability setting.
- Configure composer to find new extension modules. The following command configures composer to treat any extension code inside the ext directory as a package and creates a symlink to the vendor directory:
```
composer config repositories.ext path "./ext/*/*/*"
```
Install the pwa metapackage:
```
composer require magento/pwa
```

At this point, you should see symlinks for all the pwa modules inside the vendor directory. These symlinks allow you to:

Run a Magento installation with additional modules.
Develop locally using the standard git workflow.

You may need to ensure that there are no Magento_PWA* modules listed as enabled when you run bin/magento module:status. If there are, follow the docs on how to enable modules.

Setting up the Git workflow

To improve the developer experience even further, you can add these configurations as well:

Exclude all the ext directories in the project's .git configuration:
```
echo ext >> ./.git/info/exclude
```

Skip your project's root directory composer.\* files to avoid committing them by mistake:

git update-index --skip-worktree composer.json
git update-index --skip-worktree composer.lock

NOTE: You can reverse this operation anytime as needed:

git update-index --no-skip-worktree composer.json
git update-index --no-skip-worktree composer.lock

Cloud deployment extension installation

Add https://repo.magento.com as a composer repository by adding the following to your cloud instances composer.json file.
```
"repositories": {
    "repo": {
        "type": "composer",
        "url": "https://repo.magento.com"
    }
},
```
Require in magento/magento2-pwa extension by adding the following to your cloud instances composer.json file.
```
"require": {
    "magento/magento2-pwa": "0.0.1"
},
```
Ensure your auth.json file has valid credential for repo.magento.com.
Run composer update to update your composer.lock file.
Push the changes and deploy your cloud instance.