Venia storefront setup
Venia is a PWA storefront that runs on top of an existing Magento 2 backend. Follow the instructions on this page to setup and run the Venia PWA concept storefront.
At the end of this tutorial, you will have a working copy of the Venia storefront installed and running on top of Magento. Use this setup to explore or develop Magento PWA components and storefronts.
If you experience problems with the project setup, see Troubleshooting in the PWA Buildpack section.
- NodeJS >=10.14.1 LTS
- Yarn >=1.13.0
- Python 2.7 and build tools, see the Installation instructions on
node-gypfor your platform.
- A running instance of Magento 2.3.1 or above
Step 1. Clone the PWA Studio repository
Clone the PWA Studio repository into your development environment.
git clone https://github.com/magento-research/pwa-studio.git
Step 2. Install PWA Studio dependencies
If you have an existing
node_modules directory from a previous PWA Studio version installation, remove it to prevent installation errors.
In the PWA Studio project’s root directory, run the following command to install the project dependencies:
Step 3. Build the pwa-buildpack package
Setting up Venia requires the use of the
buildpack CLI tool in the pwa-buildpack package.
Build the pwa-buildpack package to enable the use of this tool:
yarn workspace @magento/pwa-buildpack build
Step 4. Create the
create-env-file subcommand for the
buildpack CLI tool to create a
.env file for Venia.
The subcommand generates a
packages/venia-concept/.env file where you can set the value of
MAGENTO_BACKEND_URL to the URL of a running Magento instance.
You can create the
.env file and set the
MAGENTO_BACKEND_URL value at the same time using the following command:
MAGENTO_BACKEND_URL="https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/" yarn buildpack create-env-file packages/venia-concept
If you are contributing to Venia development or exploring its features, you can use the
MAGENTO_BACKEND_URL value provided in the example command.
This URL points to a cloud instance of Magento 2.3.1 with the Venia sample data installed.
Choosing the Magento 2.3 backend
The most recent version of the Venia storefront runs on top of any Magento 2.3.1 instance.
The currently recommended Magento version to use with PWA Studio is 2.3.1, which can be installed using composer.
composer create-project --repository=https://repo.magento.com/ magento/project-community-edition:2.3.1 [destination directory]
Use the default cloud instance as the backend or set up your own local development instance.
The Venia storefront has been verified to be compatible with the following local setups:
Magento 2 installed using valet-plus
Note: If you are having
Magento2ValetDriverproblems, try downgrading to version 1.0.21.
Don’t forget to install the Venia sample data!
Step 5. Generate SSL certificate
PWA features require an HTTPS secure domain.
In the root directory, use the
create-custom-origin sub-command for the
buildpack CLI tool to generate a trusted SSL certificate for the Venia package:
yarn buildpack create-custom-origin packages/venia-concept
This feature requires administrative access, so it may prompt you for an administrative password at the command line. It does not permanently elevate permissions for the dev process but instead, launches a privileged subprocess to execute one command.
Step 6. Start the server
Before you run the server, generate build artifacts for Venia using the following command in the project root directory:
yarn run build
Run the server
Use any of the following commands from the project root directory to start the server:
yarn run watch:venia
Starts the Venia storefront development environment.
yarn run watch:all
Runs the full PWA Studio developer experience, which include Venia hot-reloading and concurrent Buildpack/Peregrine rebuilds.
yarn run build && yarn run stage:venia
Generates build artifacts and runs the staging environment, which uses more compressed assets and more closely reflects production.
Browsing to the application
After the development server is up and running, look for a similar line in the terminal output (the port may differ for your instance):
PWADevServer ready at https://magento-venia-concept-abcde.local.pwadev:8001
Launching staging server... https://magento-venia-concept-abcde.local.pwadev:51828/ Staging server running at the address above.
This is the address for your PWA frontend. You can still use the old address to access the Admin section of Magento, but for PWA development on the frontend, use this new address.
Congratulations! You have set up your development environment for the Venia storefront project.