PlaceHires React Component Library

Documentation

• Components: Storybook
• Utilities: Documentation Page

PR Requirements

• [Create a merge commit] PR commits should follow Conventional Changelog Eslint
• [Squash and merge] PR title should follow Conventional Changelog Eslint

Development

Generating New Components

yarn generate Path

This will generate:

/src
  /Path
    PathBaseName.tsx
    PathBaseName.stories.tsx

Testing

yarn test

Building

yarn build

Storybook

To run a live-reload Storybook server on your local machine:

yarn storybook

To export your Storybook as static files:

yarn storybook:build

Installing Component Library Locally

Let's say you have another project (test-app) on your machine that you want to try installing the component library into without having to first publish the component library. In the test-app directory, you can run:

npm i ../react-component-library

which will install the local component library as a dependency in test-app. It'll then appear as a dependency in package.json like:

  "dependencies": {
    ...
    "react-component-library": "file:../react-component-library",
    ...
  },
  ...

A better workflow would be to use Yalc.