Skip to content
đź› Development tools to build, optimize and deploy Progressive Web Applications for Magento 2.
JavaScript CSS Other
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Removes version checklist from pr template (#1567) Aug 15, 2019
docker Added staging port and localhost (#1444) Jul 17, 2019
packages Use eval-source-map instead of cheap-source-map for devtool (#1581) Aug 20, 2019
pwa-devdocs magento/pwa-studio#: Contributing page. Fix link (#1571) Aug 19, 2019
scripts refactor: move venia components to separate UI lib (#1499) Aug 12, 2019
.dockerignore Docker compose (#859) Mar 19, 2019
.editorconfig Add UPWARD specification, guide, tests, reference implementation (#248) Oct 4, 2018
.eslintignore feat: remove esm mid-compilation and add babel preset (#1404) Jul 19, 2019
.eslintrc.js fix(ci): Fix false CI failures from forked PRs (#230) Aug 16, 2018
.gitignore feat: remove esm mid-compilation and add babel preset (#1404) Jul 19, 2019
.nowignore feat: remove esm mid-compilation and add babel preset (#1404) Jul 19, 2019
.npmrc chore: update dependencies and dev branch (#1006) Mar 12, 2019
.prettierignore feat: remove esm mid-compilation and add babel preset (#1404) Jul 19, 2019
.yarnrc Unified system for environment-based configuration (#1224) Jun 27, 2019
CHANGELOG.md Updates repository references after the move (#1511) Aug 2, 2019
Dockerfile.dev refactor: move venia components to separate UI lib (#1499) Aug 12, 2019
Dockerfile.prod refactor: move venia components to separate UI lib (#1499) Aug 12, 2019
LICENSE.txt Doing some final touches to get the monorepo ready for public consump… Jun 13, 2018
LICENSE_AFL.txt Doing some final touches to get the monorepo ready for public consump… Jun 13, 2018
README.md Updates repository references after the move (#1511) Aug 2, 2019
babel.config.js feat: remove esm mid-compilation and add babel preset (#1404) Jul 19, 2019
docker-compose.yml refactor: move venia components to separate UI lib (#1499) Aug 12, 2019
jest.config.js refactor: move venia components to separate UI lib (#1499) Aug 12, 2019
lerna.json Merge branch 'release/2.1' into develop Mar 22, 2019
magento-compatibility.js Modify 2.3.1 version entry Jun 12, 2019
now-build.sh Unified system for environment-based configuration (#1224) Jun 27, 2019
now.json refactor: move venia components to separate UI lib (#1499) Aug 12, 2019
package.json refactor: move venia components to separate UI lib (#1499) Aug 12, 2019
prettier.config.js Setup Jest multi-project runner for monorepo, and hoist common devDep… Jun 13, 2018
yarn.lock Head and meta tags handling (#1537) Aug 16, 2019

README.md

PWA Studio

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

Documentation

PWA Studio documentation site

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:

mage2pratik-image vdiachenko-image jissereitsma-image rossmc-image
mage2pratik vdiachenko jissereitsma rossmc
bobmotor-image neeta-wagento-image mtbottens-image
bobmotor gavin2point0 neeta-wagento mtbottens
Jakhotiya-image JStein92-image bgkavinga-image philwinkle-image
Jakhotiya JStein92 bgkavinga philwinkle
bobbyshaw-image matthewhaworth-image shakyShane-image Igloczek-image
bobbyshaw matthewhaworth shakyShane Igloczek
mhhansen-image rowan-m-image artKozinets-image camdixon-image
mhhansen rowan-m artKozinets camdixon

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

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; rather than installing pwa-studio as a dependency of your project, you should install just the individual packages your project needs.

Workspaces

This repository includes the following packages as workspaces:

Other packages

This repository also includes unpublished modules that are not managed by Yarn Workspaces. They are not configured as workspaces, so their dependencies are not hoisted and must be installed separately.

Quick setup

See the Venia storefront setup topic for instructions on installing this project's dependencies and running the Venia storefront on top of an existing Magento backend.

Troubleshooting

See our Troubleshooting guide if you run into any problems.

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

Tips

  • Don't run npm install! Since this project has been configured with Yarn Workspaces, run yarn install to properly install, hoist, and cross-link dependencies.
  • Don't check in package-lock.json. There is only one lockfile, yarn.lock, and it's in the root directory.
  • To add a dependency, use workspace commands (e.g., yarn workspace @magento/venia-concept add my-module). This will associate the dependency with the right package.
  • Before pushing a commit, yarn run prettier and yarn run lint to format and inspect the source code. (There is also a git hook that will do this automatically.)
You can’t perform that action at this time.