@dering-hall/ui-kit v0.9.2

ui-kit

Dering Hall UI Kit

Installation

$ npm install @dering-hall/ui-kit

Development

It uses Storybook to test components visually on development.

$ yarn storybook # ...and browse to http://localhost:9000

Tests

$ yarn test

$ yarn test -u # run with -u to update snapshots

Build

$ npm run build

Publish

Make sure you are logged into NPM before running the publish command!

$ npm login # if needed
$ npm run build-and-publish

Adding a component

• Add JS files under src/components/NewComponent

• If component needs to be available in the NPM package, export it in src/index.js

export { default as NewComponent } from 'components/NewComponent';

• Add styles files under src/scss/components/_new-component.scss

• Import new styles in src/scss/theme.scss

  @import 'components/new-component';

• Write stories in src/stories

• Write tests in src/components/NewComponent/__tests__