Quick Start

This guide features streamlined instructions for experienced Node.js developers who want to get started with PWA Kit immediately using a demo storefront and a demo sandbox for the back end.

Prerequisites 

  • Node.js 22+ and npm 10+.
  • Apple silicon users: If you haven’t installed Rosetta already, run softwareupdate --install-rosetta.

For detailed setup instructions, see Set Up Your Local Environment.

Generate the Project 

To create a project using the Retail React App template and connect the project to the demo sandbox, open a terminal and run the following command:

1npx '@salesforce/pwa-kit-create-app@latest' --preset retail-react-app-demo

This creates a directory called retail-react-app-demo. Open this folder in your text editor and start exploring!

Start Your Web Server 

To start your local web server run the following commands:

1cd retail-react-app-demo
2npm start

Now that the development server is running, you can open a browser and preview your storefront:

Changes made to your project files will be visible in your browser when you refresh.

After you’ve completed the tasks in this guide, Deploy Your Code.

Node 20 Deprecation

Node 20 has an end-of-life date of April 30, 2026. We strongly recommend that you update your production projects to Node 22 or Node 24 by upgrading to the latest minor version of PWA Kit 3.x. See full details on Node support dates and upgrade steps in Upgrade Node Version.