Get the SFRA Repositories from GitHub
You must have access to the Salesforce CommerceCloud repositories on GitHub. You can then either download a copy of the SFRA repositories or clone the repositories on your local system. If you clone the repositories, you can issue git commands to perform tasks like getting the latest updates or seeing recent changes.
- If you donβt have a GitHub account, see Salesforce Commerce Cloud GitHub Repositories and Access .
-
Search for the following repositories, and click Clone or
download to copy each repository to your local system.
CAUTION:Clone or download the repositories next to each other, as siblings, as in the following example. If you nest the repositories, you canβt use the build tools.
your project βββ eslint-plugin-sitegenesis βββ lib_productlist βββ plugin-applepay βββ plugin_commercepayments βββ plugin_datadownload βββ plugin_giftregistry βββ plugin_instorepickup βββ plugin_productcompare βββ plugin_sitemap βββ plugin_wishlists βββ sfra-jsdoc βββ sgmf-scripts βββ storefront-reference-architecture βββ cartridges β βββ app_storefront_base β βββ modules βββ storefrontdata βββ app_custom_domain_mysite1 βββ app_custom_domain_mysite2
- eslint-plugin-sitegenesis βOptional. Used to lint and test code.
- lib_productlist βOptional. A shared code base required by both the plugin_wishlist and plugin_giftregistry repositories.
- plugin-applepay βOptional. Extends the base cartridge to add Apple Pay to your site.
- plugin_commercepayments βOptional. Provides functionality for payment integration with Stripe.
Note: For the Stripe's terms of service with the SEPA payment option, you must replace[the seller]
with the the appropriate name in thesepa_debit.message.mandate
key name entry inplugin_commercepayments/cartridges/plugin_commercepayments/cartridge/templates/resources/salesforcepayments.properties
.See SDD Core Mandate Translations for details on the SEPA Direct Debit (SDD) payment mandate.
Note: The plugin_commercepayments cartridge doesn't support payments that use the plugin-applepay or plugin_instorepickup cartridges. If you're applying additional cartridges to the storefront, you must disable the plugin-applepay and plugin_instorepickup in the site preferences and in the cartridge path.Internet Explorer isn't a supported browser for Commerce Payments.
- plugin_datadownload βOptional. Provides GDPR related functionality.
- plugin_giftregistry βOptional. Provides gift registry functionality.
- plugin_instorepickup βOptional. Provides buy-online-pick-up-in-store functionality.
- plugin_productcompare βOptional. Provides functionality to compare various products.
- plugin_sitemap βOptional. Provides sitemap functionality.
- plugin_wishlists βOptional. Provides wishlist functionality.
- plugin_ordermanagementOptional. Provides Salesforce Order Management self-service functionality.
- sfra-jsdoc βOptional. Builds the JSDoc for the project. You can extend the JSDoc to include the JSDoc for custom cartridges.
- sgmf-scripts βRequired. The command-line tools that compile the project and upload the cartridges.
-
storefront-reference-architecture
βRequired. Includes the
app_storefront_base
cartridge and amodules
cartridge that includes the server module. - storefrontdata βRequired. Contains the data for SFRA.
-
If you downloaded the repositories, expand the .zip files.
Note: On macOS, you can use the command-line unzip utility to expand the files.
Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.