Cloning the repository

Clone this repository to a directory called fs-sap-commerce-ocm (should be the default). It has to be created in the same folder as the repo for our addon.

Developing the library

Building

Call ./gradlew build to build the library. This will create the fscontentconnect-tpp-impl.js and fscontentconnect-tpp-impl.ie11.js in the dist-Folder.

Working with the accelerator storefront

Starting the docker stack for the accelerator storefront will mount the dist-Folder into the appropriate location within the hybris container. So there's nothing else to do than building the js-files and starting the docker stack, or calling deployCodebaseAndConfig.sh if the stack is already running.

Working with the spartacus storefront

To use the library within the spartacus storefront or within another node module, you need to build, pack, and deploy the library into our artifactory. To do this, you first have to login to the artifactory via npm login. This has to be done only once. Afterwards by calling ./gradlew install the library will be built, packed and deployed to our artifactory (http://artifactory.e-spirit.de/artifactory/webapp/#/artifacts/browse/tree/General/npm-local/fs-sap-commerce-ocm/-). The deployed library will be automatically named using the following schema: fs-sap-commerce-ocm-%VERSION-snapshot-%TICKETID.%TIMESTAMP.tgz

Example: fs-sap-commerce-ocm-0.0.33-snapshot-sapcc-268.20200120115852.tgz

To use the newest deployed snapshot version belonging to your ticket, add the following line to the package.json file of the storefront or any other module:

"dependencies": {
    ...,
    'fs-sap-commerce-ocm": "^0.0.33-snapshot-sapcc-268"
}

Publishing the library

The library will be automatically published to the npmjs.org registry everytime we merge a branch to master. Bamboo will take care of this.

Link to our library on npmjs.org: https://www.npmjs.com/package/fs-sap-commerce-ocm