Skip to content

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

License

Notifications You must be signed in to change notification settings

vysinsky/sfcc-playground

Repository files navigation

Salesforce Commerce Cloud Playground

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. You need to be able to access the repository (see the Trailhead module).

Configuration

The playground uses 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).

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

About

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

Topics

Resources

License

Stars

Watchers

Forks