README.md
February 12, 2026 ยท View on GitHub
๐ 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 18, 20, 22, or 24
- npm 9 or later
Create Your First Project
npx @salesforce/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!
๐ ๏ธ Nightly Builds
โ ๏ธ PWA Kit releases nightly builds on a nightly cadence for better visibility about upcoming features and a chance for implementers to test code integrations via a "preview" release. These builds are untested and unsupported. Use at your own risk! Nightly builds carry none of our guarantees associated with well-tested software. Do not use these builds in production. Some feature included in the nightly builds may not be included in final PWA Kit releases. These unreleased builds may not even load, may have undocumented features, known defects, and any number of other issues. They are intended for use by developers and others wishing to get early access to planned PWA Kit features.
๐ 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