README.md

reg-cli-report-ui

💎 New face of reg-cli report UI.

This repository is the Report UI of reg-viz/reg-cli

Screenshots

Available scripts

The following list is scripts used during development.

yarn dev

$ yarn dev

Launch the Report UI with the mock data.

yarn build

$ yarn build

Generate the JavaScript file required to embed Report UI. This is usually called in reg-viz/reg-cli.

yarn typecheck

$ yarn typecheck

Run static type checking using TypeScript.

yarn lint

$ yarn lint

Run Lint with ESLint.

yarn format

$ yarn format

Format the source code using Prettier and ESLint.

yarn storybook

$ yarn storybook

Launch the component catalog with Storybook.

yarn scaffold

$ yarn scaffold

Generate a component template.

Contribute

PRs welcome.

License

MIT License @ reg-viz