# @salesforcee/retail-react-app

> A project template that includes an isomorphic JavaScript storefront and [Progressive Web App](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps) built using [React](https://reactjs.org/) and [Express](https://expressjs.com/). It uses a mo

Latest version **1.0.1** (published 2023-07-06) · See license in LICENSE license · 0 weekly downloads

## Install

```sh
npm install @salesforcee/retail-react-app
pnpm add @salesforcee/retail-react-app
yarn add @salesforcee/retail-react-app
bun add @salesforcee/retail-react-app
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-07-06 |
| First published | 2023-07-06 |
| Weekly downloads | 0 |
| License | See license in LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^16.11.0 \|\| ^18.0.0 |
| Dependencies | 48 |
| Unpacked size | 5.4 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | yes |
| Author | cc-pwa-kit@salesforce.com |
| Maintainers | soban123 |

## Links

- npm: https://www.npmjs.com/package/@salesforcee/retail-react-app
- npm.io page: https://npm.io/package/@salesforcee/retail-react-app

## Dependencies (48)

- [msw](https://npm.io/package/msw.md) ^1.2.1
- [raf](https://npm.io/package/raf.md) ^3.4.1
- [njwt](https://npm.io/package/njwt.md) ^1.2.0
- [react](https://npm.io/package/react.md) ^18.2.0
- [helmet](https://npm.io/package/helmet.md) ^4.6.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [nanoid](https://npm.io/package/nanoid.md) ^3.3.4
- [full-icu](https://npm.io/package/full-icu.md) ^1.5.0
- [@lhci/cli](https://npm.io/package/@lhci/cli.md) ^0.11.0
- [cross-env](https://npm.io/package/cross-env.md) ^5.2.1
- [js-cookie](https://npm.io/package/js-cookie.md) ^3.0.1
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^3.1.2
- [prop-types](https://npm.io/package/prop-types.md) ^15.8.1
- [react-intl](https://npm.io/package/react-intl.md) ^5.25.1
- [bundlesize2](https://npm.io/package/bundlesize2.md) ^0.0.31
- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.1.4
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^9.0.0
- [query-string](https://npm.io/package/query-string.md) ^7.1.3
- [randomstring](https://npm.io/package/randomstring.md) ^1.2.3
- [react-helmet](https://npm.io/package/react-helmet.md) ^6.1.0
- [@formatjs/cli](https://npm.io/package/@formatjs/cli.md) ^6.0.4
- [focus-visible](https://npm.io/package/focus-visible.md) ^5.2.0
- [framer-motion](https://npm.io/package/framer-motion.md) ^10.12.9
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.10.6
- [card-validator](https://npm.io/package/card-validator.md) ^8.1.1
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.10.6
- [jest-fetch-mock](https://npm.io/package/jest-fetch-mock.md) ^2.1.2
- [react-hook-form](https://npm.io/package/react-hook-form.md) ^7.43.9
- [@chakra-ui/icons](https://npm.io/package/@chakra-ui/icons.md) ^2.0.19
- [@chakra-ui/react](https://npm.io/package/@chakra-ui/react.md) ^2.6.0
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.3.4
- [@chakra-ui/system](https://npm.io/package/@chakra-ui/system.md) ^2.5.6
- [base64-arraybuffer](https://npm.io/package/base64-arraybuffer.md) ^0.2.0
- [@chakra-ui/skip-nav](https://npm.io/package/@chakra-ui/skip-nav.md) ^2.0.15
- [@loadable/component](https://npm.io/package/@loadable/component.md) ^5.15.3
- [@peculiar/webcrypto](https://npm.io/package/@peculiar/webcrypto.md) ^1.4.2
- [@testing-library/dom](https://npm.io/package/@testing-library/dom.md) ^9.0.1
- [@tanstack/react-query](https://npm.io/package/@tanstack/react-query.md) ^4.28.0
- [@testing-library/react](https://npm.io/package/@testing-library/react.md) ^14.0.0
- [@salesforce/pwa-kit-dev](https://npm.io/package/@salesforce/pwa-kit-dev.md) 3.0.0-dev
- [@testing-library/jest-dom](https://npm.io/package/@testing-library/jest-dom.md) ^5.16.5
- [@salesforce/pwa-movado-app](https://npm.io/package/@salesforce/pwa-movado-app.md) 1.0.0
- [@salesforce/pwa-kit-runtime](https://npm.io/package/@salesforce/pwa-kit-runtime.md) 3.0.0-dev
- [@testing-library/user-event](https://npm.io/package/@testing-library/user-event.md) ^14.4.3
- [@salesforce/pwa-kit-react-sdk](https://npm.io/package/@salesforce/pwa-kit-react-sdk.md) 3.0.0-dev
- [@salesforce/commerce-sdk-react](https://npm.io/package/@salesforce/commerce-sdk-react.md) 1.0.0-dev
- [@tanstack/react-query-devtools](https://npm.io/package/@tanstack/react-query-devtools.md) ^4.29.1

## Recent versions

- 1.0.1 (latest) — 2023-07-06

## README

# The Retail React App

A project template that includes an isomorphic JavaScript storefront and [Progressive Web App](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps) built using [React](https://reactjs.org/) and [Express](https://expressjs.com/). It uses a modern headless architecture that enables developers to decouple front-end code from back-end systems. It leverages popular open-source libraries in the React ecosystem, such as [Chakra UI](https://chakra-ui.com/) components, [Emotion](https://emotion.sh/docs/introduction) (CSS-in-JS), [Webpack](https://webpack.js.org/), and many more.

Developers don’t have to worry about the underlying infrastructure, whether they’re developing their app locally, deploying it to a [Managed Runtime](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/mrt-overview.html) environment, or testing the app live.

## Requirements

-   Node 16.11 or later
-   npm 8 or later

## Get Started

To start your web server for local development, run the following command in your project directory:

```bash
npm start
```

Now that the development server is running, you can open a browser and preview your commerce app:

-   Go to http://localhost:3000/

## Localization

See the [Localization README.md](./translations/README.md) for important setup instructions for localization.

## Configuration Files

The Retail React App's configuration files are located in the `app/config` folder. For more details, see [Configuration Files](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/configuration-options.html) in the documentation.

## Documentation

The 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.

### Useful Links:

-   [Get Started](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/getting-started.html)
-   [Skills for Success](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/skills-for-success.html)
-   [Set Up API Access](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/setting-up-api-access.html)
-   [Configuration Options](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/configuration-options.html)
-   [Proxy Requests](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/proxying-requests.html)
-   [Push and Deploy Bundles](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/pushing-and-deploying-bundles.html)
-   [The Retail React App](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/retail-react-app.html)
-   [Rendering](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/rendering.html)
-   [Routing](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/routing.html)
-   [Phased Headless Rollouts](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/phased-headless-rollouts.html)
-   [Launch Your Storefront](https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/launching-your-storefront.html)

---
_Source: https://npm.io/package/@salesforcee/retail-react-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
