Home

Overview

Welcome to the PWA Studio community wiki!

The purpose of this wiki is to help you learn about, navigate, set up, and contribute to the PWA Studio project. If you are looking for developer documentation for the individual PWA Studio tools, you can find it in our documentation site.

Project directories

The pwa-studio repository is a monorepo that contains the following PWA Studio projects:

• peregrine - An eCommerce component library
• pwa-buildpack - Tool and library for building and developing a Magento PWA theme
• pwa-devdocs - The project source for the Magento PWA documentation site
• pwa-module - The Magento module needed to run Magento PWA themes
• venia-concept - A reference and proof-of-concept Magento PWA theme built using PWA Studio

Setup and installation

1. Clone the pwa-studio repository

   git clone [email protected]:magento-research/pwa-studio.git

2. Navigate to the cloned repository

   cd pwa-studio

3. Install dependencies for all projects

   yarn install

   Note: Do not run yarn install directly in the project folders under packages.

Roadmap

The Issues section in this project lists the planned features and bugs for this project. Labels on each issue provide information on the nature of the issue and the package(s) affected.

If you become an official contributor, you will receive an invitation to join our backlog grooming sessions and have direct influce over the product roadmap.

Contribute to the project

The PWA Studio project is an open source project that welcomes contributors of all skill levels.

If are looking for a place to start, we encourage you to look at issues labeled help wanted or good first issue.

See our Contribution guide for the full details on our contribution process.

Contact us

Slack channel: #pwa