ncn-utils

Docs

https://ncn-ends.github.io/ncn-utils/

Info

• Using Storybook to develop components in isolation
• Using jest for unit tests
• Using react-hooks-testing-library to test custom hooks
• Using swc for the compiler because it's faster than babel and the default jest compiler
• Using Typedoc to generate documentation, but looking for better options
• Using husky for git hooks

Future Plans

Components

• <FluidIncrementingNumber />
  • Incrementally transitions the number, tapering off at the end
• Tooltip
• Timeline

Hooks

• useDetectClickOutside
  • Detects if a click action was taken outside of a component
    • useful for modals that should be closed when clicked outside

Getting Started: Development

1. Install dependencies at project root

   npm install
   

2. Set up husky hooks

   npm run prepare
   

3. Initialize MSW

   npm run msw:build
   

4. Start Storybook server

   npm run storybook:run
   

5. Run tests

   npm run test