Skip to content
This repository has been archived by the owner on May 4, 2019. It is now read-only.

osu-cass/sb-components

Repository files navigation

npm version Build Status

Smarter Balanced Components

For use in Smarter Balanced

Documentation Status Coverage Status Codacy Badge codebeat badge

Getting Started

Install sb-components using npm:

npm install --save @osu-cass/sb-components

Typings

Included in lib

Usage

Scripts

  • npm install to setup development environment.
  • npm run storybook to launch the live demo.
  • npm run test to run snapshot tests
  • npm run test:prod to run tests with no cache
  • npm run test -- -u to update snapshot tests with new results (commit the .snap files).
  • npm run storybook-publish to publish storybook to gh-site/storybook
  • npm run tsdoc-publish to publish TypeScript docs to gh-site/tsdoc
  • npm run prepare to determine if a npm publish would succeed
  • npm run webpack to run dev webpack outputs to lib
  • npm run webpack:prod to run production webpack outputs to lib

Contribute

Links