Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 5.78 KB

README.md

File metadata and controls

106 lines (69 loc) · 5.78 KB
Raw

📢 Hey there, Salesforce Commerce Cloud community!

We’re excited to hear your thoughts on your developer experience with PWA Kit and the Composable Storefront generally! Your feedback is incredibly valuable in helping us guide our roadmap and improve our offering.

📋 Take our quick survey here: Survey

Feel free to share this survey link with your colleagues, partners, or anyone who has experience with PWA Kit. Your input will help us shape the future of our development tools.

Thank you for being a part of our community and for your continuous support! 🙌

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 18 or later
  • 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:

🔮 Forward-Looking Statements

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