Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

SalesforceCommerceCloud/create-commerce-app

Repository files navigation

create-commerce-app

This repo has been archived and is no longer in development. Please see https://github.com/SalesforceCommerceCloud/pwa-kit for using Salesforce Commerce APIs to build a headless shopping experience.

A Salesforce Commerce application generator that allows you to generate a sample commerce storefront application.

Prerequisites

Download and install Node.js and npm here. ​

Note: Only Node.js 12 LTS is supported. Any other version can cause unexpected results. To use a different version of Node.js for other projects, you can manage multiple versions of Node.js with nvm.

Quick Start

To get up and running execute the following command in a shell/terminal:

npx create-commerce-app your-app-name

This will run a npx installation of create-commerce-app and create a sample Salesforce Commerce Storefront app for you. It creates the app as a sub-directory of the current working directory with the name of the directory being the app name provided while running the above command. In order to run your new application, please follow the instructions for the sample Salesforce Commerce Storefront app. You don't need to clone the sample apps repo, but you do need to run the yarn commands shown in the root directory of your new commerce app.

Issues

First, check the open issues and Commerce Cloud Developer Center for any open issues related to the issue that you are experiencing. If not already raised please file a new issue here with all the necessary details. If you require an urgent resolution to your issue please ask your AM/CSM to file a support ticket with Salesforce Commerce.

Contributing

If you would like to contribute please take a look at our contributors' guide.

License Information

This package is licensed under BSD-3-Clause license. See the license for details.