@hodinkee/bezel-ui v3.4.9

bezel-ui by Hodinkee, Inc.

A styleguide / Component library by and for Hodinkee Inc.

Installation

npm i @hodinkee/bezel-ui --save

or

yarn add @hodinkee/bezel-ui

Contributing

1. Commit your changes.
2. Increment the version in package.json following SEMVER.
3. git push && git push --tags
4. npm publish

Prerequisites

Node.js >= 6 must be installed.

Code Style

• This project uses prettier to standardize code styles. Please install 'prettier' in your code editor of choice and have it adhere to the styles outlined in package.json

• Follow Atomic design guidelines - http://bradfrost.com/blog/post/atomic-web-design/

• For CSS, follow BEM rules - https://en.bem.info/methodology/

• Components should each be in their own directory, with tests and .scss files alongside them.

Running Tests

• npm test will run the tests once.
• npm run test:watch will run the tests on every change.

Building

• npm run build will compile es/ and lib/ folders.
• npm run clean will delete built resources.

Running Locally

• Run npm link.
• In your project, run npm link @hodinkee/bezel-ui
• Whenever you make a change here in bezel-ui, run npm run build again to compile your changes. They should then be reflected in the other project.