PWA Kit Generated App

Welcome to the PWA Kit!

Getting Started

Requirements

• Node 18 or later
• npm 9 or later

Run the Project Locally

npm start

This will open a browser and your storefront will be running on http://localhost:3000

Deploy to Managed Runtime

npm run push -- -m "Message to help you recognize this bundle"

Note: This command will push to the MRT project that matches the name field in package.json. To push to a different project, include the -s argument.

Important: Access to the Runtime Admin application is required to deploy bundles. To learn more, read our guide to Push and Deploy Bundles.

Customizing the application

This version of the application uses Template Extensibility to empower you to more easily customize base templates. Please refer to our documentation for more information.

🌍 Localization

See the Localization README.md for important setup instructions for localization.

📖 Documentation

The full documentation for PWA Kit and Managed Runtime is hosted on the Salesforce Developers portal.

Further documentation

For more information on working with the PWA Kit, refer to:

• Get Started
• Skills for Success
• Set Up API Access
• Configuration Options
• Proxy Requests
• Push and Deploy Bundles
• The Retail React App
• Rendering
• Routing
• Phased Headless Rollouts
• Launch Your Storefront