StoreFront recommendations
StoreFront <gb-recommendations> component
Getting Started
This module requires @storefront/core for the component to render
and receive data from GroupBy microservices.
Prerequisites
This module is meant to be used in a node environment which is bundled for use in the browser.
Installing
Use npm or yarn to install in a node project that uses webpack, browserify or similar.
npm install --save @storefront/recommendations
# or
yarn add @storefront/recommendationsUsage
This module provides the <gb-recommendations> component for use with StoreFront.
Mount tag
<!-- index.html -->
<body>
<gb-recommendations></gb-recommendations>
</body>// index.js
storefront.mount('gb-recommendations');Building the package
To build an individual package, run the following command:
yarn buildTo build an individual package in response to changes within the src directory, run the following command:
yarn devRunning tests
To test an individual packages, run the following command:
yarn testTo test an individual package in response to changes within the src and test directories, run the following command:
yarn tddLinting
To lint a package, run the following command:
yarn lintTo programmatically fix lint errors within a package, run the following command:
yarn lint:fixContributing
Read the contributing file to learn about how to contribute to the StoreFront project.
License
StoreFront and its related packages are MIT licensed.