@navinc/reports

A set of report based components. Written in Typescript.

You can view the current build of Storybook here.

Quick start

Please run all of the following commands from the monorepo root:

1. pnpm dlx lerna run start --stream --scope=@navinc/reports - Make changes and watch them at http://localhost:9009/
2. Watch and run your tests with pnpm dlx lerna run test:watch --stream --scope=@navinc/reports
3. Test in pipsqueak with ./bin/copy-package reports pip.
4. When it works as you need it to, build it: pnpm dlx lerna run build --stream --scope=@navinc/reports
5. Run the tests post build: pnpm dlx lerna run test --stream --scope=@navinc/reports

Getting Started with Storybook

To start Storybook, go to the monorepo root and run the following:

pnpm dlx lerna run start --stream --scope=@navinc/reports

And go to http://localhost:9009/

Building

Base Components

pnpm dlx lerna run build --stream --scope=@navinc/reports

Storybooks

pnpm dlx lerna run build:storybook --stream --scope=@navinc/reports

And open /public/reports/index.html to test storybook.

Testing

1. pnpm dlx lerna run test --stream --scope=@navinc/reports This will run Jest and our linter.

Using reports in your own projects

1. Install it in your project npm i @navinc/reports
2. Use it! Ex: import { Copy } from '@navinc/reports'
3. Refer to Storybook for implementation details for each component.