Get Started

1. Clone this repository
2. We use pnpm as our package manager. Install pnpm. Refer https://pnpm.io/installation
3. Run nvm install to install the correct node version automatically from the .nvmrc file
4. Install dependencies using pnpm i
5. To see storybook locally use pnpm dev

Development

1. Create folder for the component under
2. index.ts file to be created inside package to export the component
3. .tsx file with the actual code for the component
4. .stories.tsx file for the story book
5. [OPTIONAL] style.scss can be used inside the package. This should only be needed under rare cases as our styling should only be done through tailwind utlity classes
6. [IMP] Export the component in the top level lib/index.tsx file so that its available to be imported from published library
7. [IMP] Please refer to our front-end development guide here

Scripts

• dev: Starts the local Storybook server, use this to develop and preview your components.
• test: Runs all your tests with vitest.
• test:watch: Runs tests in watch mode.
• test:ui: Runs tests with a UI.
• test:coverage: Runs tests and generates a coverage report.
• build: Builds your Storybook as a static web application.
• build:lib: Builds your component library with Vite.
• lint: Runs ESLint.
• format:check: Check prettier formatting
• format:fix: Fixes all prettier formatting issues
• knip: Checks for unsused dependencies and exports.

Publish Beta version for testing

• First make sure you have installed the packages by running pnpm i
• Make sure you have committed all your changes (including pnpm-lock.yaml)
• pnpm build:lib - Build the lib into dist folder. This has to done before publishing, so that you publish the latest dist
• pnpm version <version>-beta.x - run this command to update the package version to be released for testing. Eg: pnpm version 2.10.6-beta.3
• npm publish --access=public --tag beta - To publish lib with beta tag for testing
• git push - Push the updated version with release tag back to your branch

Publish Production version

• First make sure you have installed the packages by running pnpm i
• Make sure you have committed all your changes (including pnpm-lock.yaml)
• pnpm build:lib - Build the lib into dist folder. This has to done before publishing, so that you publish the latest dist
• pnpm version <version> - run this command to update package version to be released for production. Eg: pnpm version 2.10.6
• npm publish --access=public --tag latest - To publish lib with latest tag for production release
• git push - Push the updated version with release tag back to your branch

License

MIT