Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magento/magento2-pwa
https://github.com/magento/magento2-pwa
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/magento/magento2-pwa
- Owner: magento
- License: other
- Created: 2021-08-25T15:18:23.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T07:28:40.000Z (4 months ago)
- Last Synced: 2024-07-12T08:48:50.922Z (4 months ago)
- Language: PHP
- Size: 268 KB
- Stars: 14
- Watchers: 13
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: NewsletterGraphQlPwa/README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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)](ContactGraphQlPwa) — Provides GraphQl functionality for the contact-us form.
- [Magento_NewsletterGraphQlPwa (magento/module-newsletter-graph-ql-pwa)](NewsletterGraphQlPwa) — 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
1. Clone and/or navigate to your [`magento2` git repository](https://github.com/magento/magento2) and check out the latest develop branch, e.g. `2.4-develop`. You may also check out and use any `2.4` release tags.
```bash
git clone [email protected]:magento/magento2.git
cd magento2
```
1. Create an `ext` directory within the root of your `magento2` project:
```bash
mkdir ext
```
1. Clone the `magento2-pwa` repository into your vendor directory name:
```bash
git clone [email protected]:magento-commerce/magento2-pwa.git ext/magento/magento2-pwa
```
1. 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:
```bash
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:
```bash
composer config repositories.ext path "./ext/*/*/*"
```
1. Install the `pwa` metapackage:
```bash
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](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/enable-module.html).
### Setting up the Git workflow
To improve the developer experience even further, you can add these configurations as well:
1. Exclude all the `ext` directories in the project's `.git` configuration:
```bash
echo ext >> ./.git/info/exclude
```
1. Skip your project's root directory `composer.\*` files to avoid committing them by mistake:
```bash
git update-index --skip-worktree composer.json
git update-index --skip-worktree composer.lock
```
NOTE: You can reverse this operation anytime as needed:
```bash
git update-index --no-skip-worktree composer.json
git update-index --no-skip-worktree composer.lock
```
## Cloud deployment extension installation
1. Add https://repo.magento.com as a composer repository by adding the following to your cloud instances `composer.json` file.
```json
"repositories": {
"repo": {
"type": "composer",
"url": "https://repo.magento.com"
}
},
```
1. Require in `magento/magento2-pwa` extension by adding the following to your cloud instances `composer.json` file.
```json
"require": {
"magento/magento2-pwa": "0.0.1"
},
```
1. Ensure your `auth.json` file has valid credential for `repo.magento.com`.
1. Run `composer update` to update your `composer.lock` file.
1. Push the changes and deploy your cloud instance.