Options
All
  • Public
  • Public/Protected
  • All
Menu

@storefront/collections

[MOVED] StoreFront collections


This repository has been moved to https://github.com/groupby/storefront.


StoreFront <gb-collections> component

npm (scoped with tag) CircleCI branch Codecov branch bitHound bitHound

semantic-release Commitizen friendly Greenkeeper badge

license API Reference

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/collections
# or
yarn add @storefront/collections

Usage

This module provides the <gb-collections> component for use with StoreFront.

Mount tag

<!-- index.html -->
<body>
  <gb-collections></gb-collections>
</body>
// index.js
storefront.mount('gb-collections');

Running the tests

Tests can be run to generate coverage information. Once run, open coverage/index.html in your browser to view coverage breakdown.

npm start coverage
# or
yarn start coverage

Tests can be run continuously for development

npm run tdd
# or
yarn tdd

Tests can also be run alone

npm test
# or
yarn test

Generated using TypeDoc