Station's library of UI Components for React.
Catalog's components are available on bit.dev, to add a component to your project as dependency, use:
yarn add @bit/station.catalog.colors
nvm
(wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
to install)npm
>= 6.13.7node
>= 13.11.0yarn
~= latest
You can use nvm i
to use the correct version of node
and npm
(or Volta as well).
Install bit
CLI globally (for publishing and such): brew install bit
or yarn global add bit-bin
bit
! Do so with: bit login
Request an invit if you don't have any yet.
As usual:
yarn
yarn start
Command | Description |
---|---|
yarn start |
build and open project's storybook on a new browser tab |
yarn build |
build components using bit |
yarn build-storybook |
build storybook static files |
yarn gen:icons |
used to rebuild icons component when src/assets/icons/ is updated |
yarn gen:images |
used to rebuild images component when src/assets/images/ is updated |
yarn chromatic |
build and push storybook static files to chromatic |
yarn postinstall |
run gen:icons and gen:images commmands sequentially |
To contribute, please get in touch with:
Chromatic is the tool we're using for UI reviews with product team. For each PR created, a storybook static files build is pushed to chromatic which generate a visual diff of master
branch with your PR's branch.
Also, it can be used as a simple hosted storybook with VCS.
Bit.dev is a fast, dynamic and collaborative way to build team component library. It lets you gradually extract, collect and reuse existing UI components written in your apps. Instead of publishing a library to NPM you can directly install components from your bit.dev library using your NPM and Yarn clients.
if you don't know bit, these resources may be useful: