Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/magento/pwa-studio

🛠Development tools to build, optimize and deploy Progressive Web Applications for Magento 2.
https://github.com/magento/pwa-studio

magento pwa pwa-storefront pwa-studio venia

Last synced: 5 days ago
JSON representation

🛠Development tools to build, optimize and deploy Progressive Web Applications for Magento 2.

Awesome Lists containing this project

README 

        
[![Coverage Status](https://coveralls.io/repos/github/magento/pwa-studio/badge.svg?branch=develop)](https://coveralls.io/github/magento/pwa-studio?branch=develop)



# PWA Studio



Magento PWA Studio is a collection of tools that lets developers build complex Progressive Web Applications on top of Magento 2 stores.



## Contributions



Are you interested in contributing to the PWA Studio project?

Check out the [community wiki][] to learn how to contribute to PWA Studio.



If you are looking for an issue to work on, visit our [community backlog board][] and look at the **Ready for Development** column.



For more information about contributing to this repository, see the [Contribution guide][].



## Useful links



[PWA Studio documentation site][documentation site] -

The best place to start learning about the tools and the technologies that PWA Studio provides.

Here, you can learn PWA Studio concepts, find API reference docs, and read tutorials on how to use PWA Studio to create your own PWA storefront.



Here are some popular topics to help you get started:



- [PWA Studio Overview][] - A high level overview of PWA Studio and what it provides to developers

- [PWA Studio Beginner Guide](https://www.youtube.com/watch?v=n8C87KQT-Bg)

- [Tools and libraries][] - A list of tools and libraries developers need to be familiar with to use PWA Studio

- [PWA Studio fundamentals][] - A series of tutorials covering common storefront development tasks

- [PWA Studio best Practices](https://developer.adobe.com/commerce/pwa-studio/guides/best-practices/)



### Venia



[![Venia](https://raw.githubusercontent.com/wiki/magento/pwa-studio/images/venia.png)][venia]



[Venia][] is a Magento PWA storefront created and powered by PWA Studio tools and libraries.

Developers can use Venia as a reference storefront for their own projects or as a starting point for customization.



## About this repository



To facilitate local development, testing, and versioning, PWA Studio is structured as a monorepo using [Yarn Workspaces][].

Packages in this repository are independently published to [NPM][].

Install individual packages as needed instead of installing the entire `pwa-studio` project as a dependency of your project.



**Note:** If you are installing the whole PWA Studio monorepo, please be aware that the project uses `yarn workspaces` and does not support `npm install`. Please use `yarn install` instead.



### Packages



This repository includes the following packages:



- [**peregrine**](https://developer.adobe.com/commerce/pwa-studio/guides/packages/peregrine/) - A component library for adding logic to visual components

- **venia-ui** - A library of visual components for PWA storefront projects

- **venia-concept** - A concept storefront project built using PWA Studio tools

- [**pwa-buildpack**](https://developer.adobe.com/commerce/pwa-studio/guides/packages/buildpack/) - A tooling library to help with PWA storefront development

- [**upward-spec**](https://developer.adobe.com/commerce/pwa-studio/guides/packages/upward/) - UPWARD specification and test suite

- [**upward-js**](https://developer.adobe.com/commerce/pwa-studio/guides/packages/upward/javascript/) - A reference implementation of the UPWARD specification

- **babel-preset-peregrine** - A [babel][] preset plugin that is required to use peregrine components

- **graphql-cli-validate-magento-pwa-queries** - A script to validate your project's GraphQL queries against a schema

- [**pwa-devdocs**](pwa-devdocs) - Project source for the [documentation site][]



If you have an issue that cannot be resolved, please [create an issue][].



### PWA Studio XD Kit



Adobe XD makes handoff between designers and engineers more efficient through easy-to-use collaboration tools. The [PWA Studio XD Kit][] contains a collection of templates and components compatible with Adobe Commerce.



### Join the conversation



If you have any project questions, concerns, or contribution ideas, join our [#pwa slack channel][]!



Here you can find a [public calendar][] with events that Magento PWA team runs with Community. You can also [add that calendar][] to your calendar app to stay up to date with the changes and get notifications.



### Community Maintainers



A community maintainer is a point of contact from the community approved by the Core Team to help with community outreach and project administration.



The following members are the community maintainers for this project:



[![larsroettig-image]][larsroettig]

[![Jordaneisenburger-image]][Jordaneisenburger]



[Jordaneisenburger]: https://github.com/Jordaneisenburger

[Jordaneisenburger-image]: https://avatars0.githubusercontent.com/u/19858728?v=4&s=60



[larsroettig]: https://github.com/larsroettig

[larsroettig-image]: https://avatars0.githubusercontent.com/u/5289370?v=4&s=60



### Top Community Contributors



The PWA Studio project welcomes all codebase and documentation contributions.

We would like to recognize the following community members for their efforts on improving the PWA Studio project in our latest release.



| Author           | Commits | Added Lines | Removed Lines | Avg. Files |

| ---------------- | ------- | ----------- | ------------- | ---------- |

| Justin Conabree  | 94      | 15932       | 4837          | 7.117      |

| Mikhaël Bois     | 46      | 7675        | 2000          | 12.226     |

| Pankhuri Goel    | 28      | 11402       | 9343          | 13.606     |

| Lars Roettig     | 15      | 2350        | 862           | 8.067      |

| Pedro Chiossi    | 9       | 9063        | 7625          | 38.571     |

| Allan Yanik      | 6       | 834         | 677           | 25         |

| Sofia Hernandez  | 6       | 781         | 145           | 21         |

| Oleksandr Krasko | 2       | 193         | 1             | 4          |

| Antoine Fontaine | 1       | 44          | 45            | 14         |

| Shikha Mishra    | 1       | 584         | 5             | 13         |



_Last Updated: October 14, 2021_



**Source:** [statistic.magento.engineering][]



[statistic.magento.engineering]: 



[Contribution guide]: .github/CONTRIBUTING.md

[Coverage Status]: https://coveralls.io/repos/github/magento/pwa-studio/badge.svg?branch=main

[create an issue]: https://github.com/magento/pwa-studio/issues/new

[documentation site]: https://developer.adobe.com/commerce/pwa-studio/

[Git hook]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

[NPM]: https://www.npmjs.com/org/magento

[selective dependency resolutions]: https://yarnpkg.com/lang/en/docs/selective-version-resolutions/

[Troubleshooting]: https://developer.adobe.com/commerce/pwa-studio/troubleshooting/

[Venia storefront setup]: https://developer.adobe.com/commerce/pwa-studio/tutorials/setup-storefront/

[PWA Studio fundamentals]: https://developer.adobe.com/commerce/pwa-studio/tutorials/setup-storefront/

[workspace commands]: https://yarnpkg.com/en/docs/cli/workspace

[Yarn Workspaces]: https://yarnpkg.com/en/docs/workspaces/

[community wiki]: https://github.com/magento/pwa-studio/wiki

[pwa studio overview]: https://developer.adobe.com/commerce/pwa-studio/guides/

[tools and libraries]: https://developer.adobe.com/commerce/pwa-studio/guides/project/tools-libraries/

[venia storefront setup]: https://developer.adobe.com/commerce/pwa-studio//tutorials/setup-storefront/

[project coding standards and conventions]: https://github.com/magento/pwa-studio/wiki/Project-coding-standards-and-conventions

[community backlog board]: https://github.com/magento/pwa-studio/projects/1

[#pwa slack channel]: https://magentocommeng.slack.com/messages/C71HNKYS2

[babel]: https://babeljs.io/

[venia]: https://venia.magento.com/

[public calendar]: https://opensource.magento.com/community-calendar

[add that calendar]: https://calendar.google.com/calendar/ical/sn3me3pduhd92hhk9s7frkn57o%40group.calendar.google.com/public/basic.ics

[PWA Studio UI Kit]: https://developer.adobe.com/commerce-xd-kits/