/pwa-studio

đź› Development tools to build, optimize and deploy Progressive Web Applications for Magento 2.

Primary LanguageJavaScriptOpen Software License 3.0OSL-3.0

PWA Studio

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

Useful links

PWA Studio 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 learning resources from Magento U - Just starting out with Progressive Web Application technologies in general? Check out Magento U's learning resource page for PWA. It contains links to online training, tutorials, and courses on the technologies you need to know to use PWA Studio.

Venia

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.

Packages

This repository includes the following 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 - A tooling library to help with PWA storefront development
  • upward-spec - UPWARD specification and test suite
  • upward-js - 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 - Project source for the documentation site

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

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 backlog board and look at the Good First Issue column.

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

Join the conversation

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

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 Jordaneisenburger-image

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 2020.

Author Commits Added Lines Removed Lines Avg. Files
Lars Roettig 17 1430 1101 5.824
Ross McHugh 12 1089 11 2
Lucas Calazans 5 378 194 3.2
Luke Denton 5 85 39 1.4
Jordan Eisenburger 4 334 39 3
Kristof, Fooman 4 103 74 3
Adam 3 328 16 2.667
Harald Deiser 3 150 123 12.667
Brendan Falkowski 2 1168 416 12.5
Huy Kon 2 991 39 10
Miguel Balparda 2 8 6 1
Shikha Mishra 2 16 12 2
christopher daniel 2 163 106 6.5
sivakumarkoduru 2 7 4 1.5
Alexander Taranovsky 1 4 1 2
Andrii Beziazychnyi 1 4 0 1
Cody Nguyá»…n 1 1 1 1
Davide 1 9 7 1
Dominic Fernando 1 0 1 1
Evan Burrell 1 92 29 11

Last Updated: September 3, 2020

Source: statistic.magento.engineering