Skip to content

React-based JavaScript frontend framework to create a progressive web app (PWA) storefront for Salesforce B2C Commerce.

License

Notifications You must be signed in to change notification settings

SalesforceCommerceCloud/pwa-kit

Repository files navigation

The Progressive Web App (PWA) Kit

npm License Checks npm

๐Ÿ“– 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.

pwa-kit banner


๐Ÿ„ Get Started

Requirements

  • Node 14.17.0 or later
  • npm 6.14.4 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:

๐Ÿ”ฎ Forward-Looking Statements

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