• Node 18 or later
• npm 9 or later

npx @salesforce/pwa-kit-create-app

Enter your sandbox configuration.

npm start

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.

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

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

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!

⚠️ 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.

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

• 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

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