The Progressive Web App (PWA) Kit

📖 Read Docs | 🏖️ View Demo | 🚀 Deploy | ➕ Contribute

The PWA Kit is a storefront technology for headless commerce using Salesforce Commerce APIs and React. It provides front-end developers with a more flexible and agile approach to build and maintain modern shopping experiences.

---

🏄 Get Started

Requirements

• Node 16 or later
• npm 8 or later

Create Your First Project

npx pwa-kit-create-app

Enter your sandbox configuration.

Run the Project Locally

npm start

Deploy to Managed Runtime

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

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

🌍 Localization

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

⚠️ License Information

The PWA Kit is licensed under a BSD 3-Clause license. See the license for details.

➕ Contribute

Your contributions are welcome! Refer to the CONTRIBUTING guide to get started. If you like pwa-kit, consider adding a ⭐ on the GitHub Repo. It helps other people discover PWA Kit!

📖 Documentation

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

Useful Links:

• 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

🔮 Forward-Looking Statements

This repository may contain forward-looking statements that involve risks, uncertainties, and assumptions. For more information, see STATEMENTS