{"id":18406340,"url":"https://github.com/salesforcecommercecloud/pwa-kit","last_synced_at":"2025-05-14T13:06:45.964Z","repository":{"id":37072848,"uuid":"388858461","full_name":"SalesforceCommerceCloud/pwa-kit","owner":"SalesforceCommerceCloud","description":"React-based JavaScript frontend framework to create a progressive web app (PWA) storefront for Salesforce B2C Commerce.","archived":false,"fork":false,"pushed_at":"2025-05-12T13:56:28.000Z","size":294495,"stargazers_count":302,"open_issues_count":153,"forks_count":157,"subscribers_count":26,"default_branch":"develop","last_synced_at":"2025-05-12T14:57:42.611Z","etag":null,"topics":["ecommerce","javascript","monorepo","nodejs","progressive-web-app","pwa","react","salesforce","salesforce-developers","storefront"],"latest_commit_sha":null,"homepage":"https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pwa-kit-overview.html","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SalesforceCommerceCloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-07-23T16:14:54.000Z","updated_at":"2025-05-11T19:28:48.000Z","dependencies_parsed_at":"2024-01-20T01:56:31.531Z","dependency_job_id":"83bf2f01-eca6-4809-9027-ae900110e5e8","html_url":"https://github.com/SalesforceCommerceCloud/pwa-kit","commit_stats":{"total_commits":2205,"total_committers":63,"mean_commits":35.0,"dds":0.8603174603174604,"last_synced_commit":"bb817dfe8a9e1594283c7b33e580868ea1cc47c6"},"previous_names":[],"tags_count":550,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalesforceCommerceCloud%2Fpwa-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalesforceCommerceCloud%2Fpwa-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalesforceCommerceCloud%2Fpwa-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalesforceCommerceCloud%2Fpwa-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SalesforceCommerceCloud","download_url":"https://codeload.github.com/SalesforceCommerceCloud/pwa-kit/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254149955,"owners_count":22022851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecommerce","javascript","monorepo","nodejs","progressive-web-app","pwa","react","salesforce","salesforce-developers","storefront"],"created_at":"2024-11-06T03:08:20.242Z","updated_at":"2025-05-14T13:06:40.950Z","avatar_url":"https://github.com/SalesforceCommerceCloud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ch1\u003eThe Progressive Web App (PWA) Kit\u003c/h1\u003e\n\n[![npm](https://img.shields.io/npm/v/@salesforce/pwa-kit-react-sdk.svg)](https://www.npmjs.com/package/@salesforce/pwa-kit-react-sdk)\n[![License](https://img.shields.io/github/license/SalesforceCommerceCloud/pwa-kit.svg)](https://github.com/SalesforceCommerceCloud/pwa-kit/blob/master/LICENSE)\n[![Checks](https://img.shields.io/github/checks-status/SalesforceCommerceCloud/pwa-kit/develop.svg)](https://github.com/SalesforceCommerceCloud/pwa-kit)\n[![npm](https://img.shields.io/npm/dm/@salesforce/pwa-kit-react-sdk.svg)](https://www.npmjs.com/package/@salesforce/pwa-kit-react-sdk)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n📖 [Read Docs](https://sfdc.co/pwa-kit) |\n🏖️ [View Demo](https://pwa-kit.mobify-storefront.com/) |\n🚀 [Deploy](https://runtime.commercecloud.com/) |\n➕ [Contribute](https://github.com/SalesforceCommerceCloud/pwa-kit/blob/develop/CONTRIBUTING.md)\n\u003cbr /\u003e\u003cbr /\u003e\nThe 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.\n\u003cbr/\u003e\u003cbr/\u003e\n\u003cimg alt=\"pwa-kit banner\" src=\"https://raw.githubusercontent.com/SalesforceCommerceCloud/pwa-kit/develop/packages/template-retail-react-app/app/static/img/hero.png\" style=\"width: 700px; height:auto;\"\u003e\n\n\u003c/div\u003e\n\n---\n\n## 🏄 Get Started\n\n### Requirements\n\n-   Node 18 or later\n-   npm 9 or later\n\n### Create Your First Project\n\n```bash\nnpx @salesforce/pwa-kit-create-app\n```\n\nEnter your [sandbox configuration](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/getting-started.html#new-project).\n\n### Run the Project Locally\n\n```bash\nnpm start\n```\n\n### Deploy to Managed Runtime\n\n```\nnpm run push -- -m \"Message to help you recognize this bundle\"\n```\n\n**Important**: Access to the [Runtime Admin](https://runtime.commercecloud.com/) application is required to deploy bundles. To learn more, read our guide to [Push and Deploy Bundles](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pushing-and-deploying-bundles.html).\n\n## 🌍 Localization\n\nSee the [Localization README.md](./packages/template-retail-react-app/translations/README.md) for important setup instructions for localization.\n\n## ⚠️ License Information\n\nThe PWA Kit is licensed under a BSD 3-Clause license. See the [license](./LICENSE) for details.\n\n## ➕ Contribute\n\nYour contributions are welcome! Refer to the [CONTRIBUTING](./CONTRIBUTING.md) guide to get started. If you like `pwa-kit`, consider adding a ⭐ on the [GitHub Repo](https://github.com/SalesforceCommerceCloud/pwa-kit/). It helps other people discover PWA Kit!\n\n## 🛠️ Nightly Builds\n\n⚠️ 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!\nNightly builds carry none of our guarantees associated with well-tested software. **Do not use these builds in production**.\nSome feature included in the nightly builds may not be included in final PWA Kit releases.\nThese unreleased builds may not even load, may have undocumented features, known defects, and any number of other issues.\nThey are intended for use by developers and others wishing to get early access to planned PWA Kit features.\n\n## 📖 Documentation\n\nThe full documentation for PWA Kit and Managed Runtime is hosted on the [Salesforce Developers](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/overview) portal.\n\n### Useful Links:\n\n-   [Get Started](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/getting-started.html)\n-   [Skills for Success](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/skills-for-success.html)\n-   [Set Up API Access](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/setting-up-api-access.html)\n-   [Configuration Options](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/configuration-options.html)\n-   [Proxy Requests](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/proxying-requests.html)\n-   [Push and Deploy Bundles](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pushing-and-deploying-bundles.html)\n-   [The Retail React App](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/retail-react-app.html)\n-   [Rendering](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/rendering.html)\n-   [Routing](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/routing.html)\n-   [Phased Headless Rollouts](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/phased-headless-rollouts.html)\n-   [Launch Your Storefront](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/launching-your-storefront.html)\n\n## 🔮 Forward-Looking Statements\n\nThis repository may contain forward-looking statements that involve risks, uncertainties, and assumptions. For more information, see [STATEMENTS](STATEMENTS.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforcecommercecloud%2Fpwa-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsalesforcecommercecloud%2Fpwa-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalesforcecommercecloud%2Fpwa-kit/lists"}