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.
NOTE: There are different branches covering the various versions and configurations of an SAP Commerce Cloud solution, so make sure to choose the right one.
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.
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.
- js-storefront: A project Spartacus JS Storefront configured with Server Side Rendering (SSR). For more on project Spartacus see project Spartacus documentation
core-customize folder
- manifest.json: The Commerce Cloud manifest.json file, which defines how your code will be built and deployed in the Public Cloud environments. The manifest is set up to leverage confiuration reuse to better allow for consistency between local and cloud builds.
- hybris folder: contains a sample custom folder for storing any custom extensions as well as the config folder for storing local and cloud properties, localextensions.xml and any local solr/tomcat configurations
Clone the sample repository (instructions can be found here). The files are copied to your local machine.
- If you don’t have custom extensions, you can delete the kiwi & tiger sample folders. If you wish to use these extensions you'll have to uncomment them in your hybris/config/localextensions.xml folder
- List any extensions you're using (custom and any from Commerce runtime) in the core-customize/hybris/config/localextensions.xml file
- 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 your localextension.xml and manifest.json files
- 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.
In the sample repository, verify that you have the following files in the js-storefront folder.
- manifest.json: This is the file that tells Cloud Automation the name and path of the JavaScript storefronts you want to build and deploy
Push all the contents 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 Initialze Database option.
You may also wish to see this video which provides a walkthrough of how to connect your repository, as well as this video which outlines how to build and deploy
See Build and Deploy your First SAP Commerce Cloud Project for all the steps to build and deploy.
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.