Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.34 KB

README.md

File metadata and controls

53 lines (37 loc) · 1.34 KB

Stacks UI

GitHub license npm version

A bare-bones react component library for building platform independent storefront integrations for ecommerce stores.

Installation

Install with NPM

$ npm install --save @boldcommerce/stacks-ui

Install with Yarn

$ yarn add @boldcommerce/stacks-ui

Webpack and Style-Loader

Each component has it's own CSS file rather than packaging all of the CSS into a single file to be included in your project. This means you'll need to install the style-loader plugin for Webpack.

Styleguide & Documentation

Stacks comes with interactive documentation and playground using react styleguidist.

To access the docs: First, clone the repo.

Next install the package dependencies:

$ yarn install

Finally, spin up styleguidist

$ yarn docs

Tests

Running the tests

$ yarn test

Updating the snapshot the tests

$ yarn test -u