@dagangan/react-components

@dagangan/components

This is react-components libraries bootstrapping with TSDX.

Requirements

Before you proceed, please make sure your machine has met the following requirements:

Dependency	Version
Node	>= v14.17.6
NPM	>= v6.14.15

Quick Start

Installation

# clone repo into `dgn-react-components`
# install project dependencies
cd dgn-react-components && npm install
npx husky install

Running app

npm start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

Then run Storybook for the playground:

Storybook

Run inside another terminal:

npm run storybook

This loads the stories from ./stories.

NOTE: Stories should reference the components as if using the library.

Testing

npm run build
# move to another project (eg: cd ../next-project)
npm install ../dgn-react-components # (directory of dgn-react-components)

Jest

Jest tests are set up to run with npm test.

Bundle analysis

Calculates the real cost of your library using size-limit with npm run size and visulize it with npm run analyze.

Setup Files

This is the folder structure we set up for you:

/src
  index.tsx       # EDIT THIS
/test
  blah.test.tsx   # EDIT THIS
/stories
  Thing.stories.tsx # EDIT THIS
/.storybook
  main.js
  preview.js
.gitignore
package.json
README.md         # EDIT THIS
tsconfig.json

DONT REPEAT YOURSELF - HAPPY CODING