Install Step 1: Acquiring the Fast SFCC SFRA Cartridge
AVAILABLE SOON:
The Fast Salesforce Reference Architecture (SFRA) Cartridge should be available via the Commerce Cloud Partner Marketplace, which allows you to download the compressed Cartridge as a ZIP file.
Required Accounts
Prior to downloading the cartridge, you will need:
- Salesforce Commerce Cloud credentials to access the Salesforce Commerce Cloud GitHub Organization
- An existing GitHub account (or sign up for a new one)
Download the Fast Cartridge
Download one of the following versions of the Fast Cartridge:
- (Recommended for Most Users) Marketplace Fast Cartridge - the SFCC Marketplace version of the Fast Cartridge. Stable and recommended for most users.
- (Latest Version) Dev Fast Cartridge - our in-development version of the Fast Cartridge with the latest features (e.g. for site admins who want to try development builds in Sandbox).
Custom Cartridge ZIP File
If needed, a Fast team member can also provide the cartridge as a ZIP file incorporating the additional details you provided prior to starting the installation process.
Upload the Cartridge to Your Storefront
Once you have the Cartridge downloaded, you will need to upload it to your Storefront Reference Architecture (SFRA) storefront.
This can be accomplished several ways, including the options outlined below.
Upload Option 1: Using the SFRA command-line upload tool
Please follow the steps in the SFRA command-line upload tool documentation to get started.
Custom JSON file required for command-line upload tool
This method will require setting up a dw.json file to connect to your site.
{
"hostname": "yoursandbox-inside-your-realm.demandware.net",
"username": "YOUR_BUSINESS_MANAGER_USERNAME",
"password": "YOUR_BUSINESS_MANAGER_PASSWORD",
"code-version": "version1"
}Upload Option 2: Using the Prophet Debugger VS Code extension
- Add the Prophet Debugger extension to your VS Code.
- Open the Fast Cartridge you downloaded in VS Code and create a
dw.jsonfile in theint_fast_sfrafolder (the file path should beint_fast_sfra/dw.json)
{
"hostname": "yoursandbox-inside-your-realm.demandware.net",
"username": "YOUR_BUSINESS_MANAGER_USERNAME",
"password": "YOUR_BUSINESS_MANAGER_PASSWORD",
"code-version": "version1"
}-
Navigate to the Prophet Debugger extension in the VS Code sidebar, and locate the "CARTRIDGES" section. Click on the
Prophet: Clean Project / Upload allicon.
Retain extra cartridges
If you receive a popup that says "Your popup has extra cartridges... what would you like to do?", select
Leave AllorLeave All Alwaysfrom the available options. The extra cartridges are necessary for the SFCC storefront.
Upload Option 3: Using Salesforce UX Studio
You can also use Salesforce UX Studio (legacy software) to upload the cartridge.
- File > Import > General > Existing Projects into Workspace.
- Browse to the location of the compressed cartridge file
- Confirm subsequent prompts to finish the upload