Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 3.29 KB

README.md

File metadata and controls

61 lines (47 loc) · 3.29 KB
Raw

React components for the DRT application suite

React components for Border Force DRT applications. Built using this boilerplate.

Storybook available at: https://ukhomeoffice.github.io/drt-react/

Dependency Versioning

This component library is a dependency of the Scala.js implementation in the drt-v2 application and as such strict version matching is required. The following dependencies have been locked at specific versions, following the definitions in the drt-v2 project settings

Dependency Version
react 18.2
react-dom 18.2
@mui/material 5.11
@mui/lab 5.0.0-alpha.119
@mui/icons-material 5.11.16

Features

  • Rollup for bundling
  • Bundles commonjs and es module formats
  • Jest & React Testing Library : For testing our components
  • Support for TypeScript
  • Sourcemap creation
  • Support of CSS/SASS: For exporting components with style
  • Storybook: For testing our components within the library itself as we design them
  • Supports complicated peer-dependencies (example here is Antd so here the power of rollup-plugin-peer-deps-external we can use complicated peer dependency such Antd without having it bundled as a part of your module.)
  • Optimizing bundle size: @rollup/plugin-terser A Rollup plugin to generate a minified bundle with terser.
  • Automatically externalize peerDependencies in a rollup bundle, thanks to rollup-plugin-peer-deps-external
  • Eslint
  • Deploy Storybook to GitHub Pages

Development:

  • Storybook:

    • Storybook gives you an easy way to see and use your components while working on them in your library project, without having to build an unnecessary testing page just to display them.

      npm run storybook # runs the host Storybook application locally for quick and easy testing

Now, anytime you make a change to your library or the stories, the storybook will live-reload your local dev server so you can iterate on your component in real-time.

  • Rollup watch and build:

    • for Local development run rollup to watch your src/ module and automatically recompile it into dist/ whenever you make changes.

      npm run dev # runs rollup with watch flag

Scripts:

  • npm run build : builds the library to dist
  • npm run dev : builds the library, then keeps rebuilding it whenever the source files change.
  • npm test : tests the library and show the coverage.
  • npm run lint : runs eslint.
  • npm run storybook : runs the host Storybook application locally for quick and easy testing
  • npm run build-storybook : builds a static HTML/JS bundle that can easily be hosted on a remote server, so all members of your team can try your components.
  • npm run deploy-storybook : build & deploy the storybook to GitHub Pages

License

MIT.