This sample repository contains the files and folders that are required to set up SAP Commerce Cloud. You can clone this repository and then follow the instructions in the readme to update the example files with your specific details.
When your files are ready, push them to your SAP Commerce Cloud repository.
- You have a public-facing code repository.
- You have an active SAP Commerce Cloud subscription.
- You have a license for SAP Commerce version 1808 or higher.
- You have not set up SAP Commerce Cloud yet.
You can find the supported SAP Commerce versions listed in the Compatibility help topic.
Not applicable.
These instructions walk you through the process of cloning the repository and then updating the sample files with your specific requirements.
There are multiple branches to choose from based on your specific configuration needs.
- master: This branch contains a sample Commerce Cloud only configuration. This should be used in MOST cases.
- 1905-datahub: This branch contains the contents from master in additional to configuration files used for Data Hub. Data Hub is an add-on purchase for Commerce Cloud.
- 1905-spartacus: This branch contains the configuration necessary to use Commerce Cloud with the Spartacus JavaScript storefront.
Clone the sample repository (instructions can be found here). The files are copied to your local machine.
The following folders and files are included in the sample repository.
Root level
- core-customize folder: The folder that contains all of the folders and files that support Commerce Cloud.
core-customize folder
- manifest.json: The Commerce Cloud manifest.json file, which defines Commerce Platform customizations.
- kiwi folder: An example custom extension.
- tiger folder: An example custom extension.
- other sample manifests: A collection of tested and verified manifest files that you can use as starting points for your Commerce Cloud environments.
- If you don’t have custom extensions, you can delete the kiwi & tiger sample folders.
- If you do have custom extensions, create a folder for each custom extension and add your extension files.
- List the custom extensions in the manifest.json file that is inside the core-customize directory.
- If you have custom extensions with dependencies, list the source extension first, then the dependent extension. Extensions are built in the order in which they appear in the manifest file.
- Open the manifest.json file inside the core-customize folder.
- Update the “version” with the version of SAP Commerce that you plan to use. Refer to the Supported Versions section of this readme for more information.
- Save the changes.
In the sample repository, verify that you have the following files in the core-customize folder.
- manifest.json: This is the manifest.json for Commerce Cloud.
- folders (optional)
Push the core-customize folder from your local machine to the root level of your Commerce Cloud repository.
Log in to the Cloud Portal and verify that your code repository is connected.
- From a supported browser, log in to https://portal.commerce.ondemand.com. For more information, see Accessing the Cloud Portal.
- Select Repository and verify that you are connected to the correct code repository.
- Find the environments that were provisioned for your subscription.
- Create a new build.
- Deploy the build to the environment using the Initialize Database option.
Use the Cloud Portal to create a build and then deploy the build to an environment.
- After the build is deployed, you can find the 'Storefront' endpoint in the Environments page of the Cloud Portal listed under Public Endpoints.
- Click on the Storefront hyperlink to access the details page for endpoint.
- Either add an IP Filter Set for your IP address OR change the Base Rule from 'Deny All' to 'Allow All' in order to receive traffic to this example storefront.
- Save the changes.
- Click on the URL listed next to the Storefront public endpoint. You will receive a server error.
- In your browser's address, append the endpoint address with /?site=electronics and reload the page
- Verify that you see a basic electronics storefront.
The repository must be a public-facing repository. You cannot use a private repository to host SAP Commerce Cloud configurations.
There are no known issues at this time.
This repository is provided "as-is"; no support is available.
Find more information about SAP Commerce Cloud Setup on our help site.
Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the “SAP Sample Code License” except as noted otherwise in the LICENSE file.