https://github.com/vysinsky/sfcc-playground

Salesforce Commerce Cloud Playground simulates SFCC server behaviour so you can develop controllers locally, use nice debug tools etc.
https://github.com/vysinsky/sfcc-playground

demandware developer-experience developer-tools dx express playground salesforce salesforce-commerce-cloud sfcc

Last synced: 2 days ago
JSON representation

Salesforce Commerce Cloud Playground simulates SFCC server behaviour so you can develop controllers locally, use nice debug tools etc.

• Host: GitHub
• URL: https://github.com/vysinsky/sfcc-playground
• Owner: vysinsky
• License: mit
• Created: 2022-05-12T09:02:59.000Z (over 2 years ago)
• Default Branch: beta
• Last Pushed: 2023-03-02T23:29:24.000Z (over 1 year ago)
• Last Synced: 2024-09-19T07:11:12.597Z (16 days ago)
• Topics: demandware, developer-experience, developer-tools, dx, express, playground, salesforce, salesforce-commerce-cloud, sfcc
• Language: JavaScript
• Homepage:
• Size: 2.16 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Salesforce Commerce Cloud Playground

![playground-ui.png](playground-ui.png)

## Installation

`npm install --global sfcc-playground@beta`

or if you feel adventurous, use alpha

`npm install --global sfcc-playground@alpha`

The playground uses [`dw-api-mock`](https://github.com/SalesforceCommerceCloud/dw-api-mock.git). You need to be able to access the repository ([see the Trailhead module](https://trailhead.salesforce.com/content/learn/modules/b2c-developer-resources-and-tools/b2c-developer-access-repositories)).

## Configuration

The playground uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) so you can use:

- a `sfcc-playground` property in package.json

- a `.sfcc-playgroundrc` file in JSON or YAML format

- a `.sfcc-playgroundrc.json`, `.sfcc-playgroundrc.yaml`, `.sfcc-playgroundrc.yml`, `.sfcc-playgroundrc.js`, or `.sfcc-playgroundrc.cjs` file

- a `sfcc-playground.config.js` or `sfcc-playground.config.cjs` CommonJS module exporting an object

### Configuration options

| Value | Description | Default value |

| --- | --- | --- |

| rootDir | Root directory of the project | `process.cwd()` |

| cartridgesDir | Path to cartridges directory | `${cwd}/cartridges` |

| cartridgePath | Cartridge path | app_storefront_base |

| modulesPath | Path to modules directory | `${cwd}/cartridges/modules` |

| apiPort | Port to use for API app | 8080 |

## Usage

Run the playground in your project folder (create a config file if needed).

```shell

sfcc-playground

```

Open browser on `http://localhost:8080` (or on the port you specified in the config).

## Roadmap

See [https://github.com/users/vysinsky/projects/1/views/1](https://github.com/users/vysinsky/projects/1/views/1)