https://github.com/bold-commerce/stacks-ui
A bare-bones react component library for building platform independent storefront integrations for ecommerce stores.
https://github.com/bold-commerce/stacks-ui
snyk-scan
Last synced: 10 months ago
JSON representation
A bare-bones react component library for building platform independent storefront integrations for ecommerce stores.
- Host: GitHub
- URL: https://github.com/bold-commerce/stacks-ui
- Owner: bold-commerce
- License: mit
- Created: 2021-01-26T23:59:40.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-25T20:39:51.000Z (almost 3 years ago)
- Last Synced: 2025-05-08T21:44:13.924Z (about 1 year ago)
- Topics: snyk-scan
- Language: JavaScript
- Homepage:
- Size: 261 KB
- Stars: 3
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Stacks UI
[](https://github.com/bold-commerce/stacks-ui/blob/main/LICENSE.md) [](https://www.npmjs.com/package/@boldcommerce/stacks-ui)
A bare-bones react component library for building platform independent storefront integrations for ecommerce stores.
## Installation
Install with NPM
```bash
$ npm install --save @boldcommerce/stacks-ui
```
Install with Yarn
```bash
$ 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][wsl] plugin for Webpack.
## Styleguide & Documentation
Stacks comes with interactive documentation and playground using [react styleguidist][rsg].
To access the docs: First, [clone the repo][gh].
Next install the package dependencies:
```bash
$ yarn install
```
Finally, spin up styleguidist
```bash
$ yarn docs
```
## Tests
Running the tests
```bash
$ yarn test
```
Updating the snapshot the tests
```bash
$ yarn test -u
```
[wsl]: https://github.com/webpack-contrib/style-loader
[rsg]: https://github.com/styleguidist/react-styleguidist
[gh]: https://github.com/boldcommerce/stacks-ui