@patrick_gratao/vite-component-library-template
v0.0.15
Published
- βοΈ [React 18](https://reactjs.org/) - π [Storybook 7](https://storybook.js.org/) - Components preview - ποΈ [Tailwind CSS 3](https://tailwindcss.com/) - β© [Vite](https://vitejs.dev/) - Run and build the project blazingly fast! - β‘ [Vitest](https://
Downloads
5
Readme
βοΈβ‘ Vite + React + Typescript Component Library Template
Features
- βοΈ React 18
- π Storybook 7 - Components preview
- ποΈ Tailwind CSS 3
- β© Vite - Run and build the project blazingly fast!
- β‘ Vitest - Components Unit Testing
- π ESLint & Prettier - Formatting and Linting
- π Typescript
- πΆ Husky & Lint Staged - Pre-commit Hooks
- β° Release Please β Generate the changelog with the release-please workflow
- π· Github Actions β Releasing versions to NPM
- Initial components setup using Atomic Design
Getting Started
- Create a new repository using this one as template
- Clone your repo
- Install dependencies with
pnpm i
(first runcorepack enable
to enable pnpm) - Run
pnpm prepare
command to setup Husky pre-commit hooks.
Main Scripts
Always prepending pnpm:
dev
: Bootstrap the Storybook preview with Hot Reload.build
: Builds the static storybook project.build:lib
: Builds the component library into the dist folder.lint:fix
: Applies linting based on the rules defined in .eslintrc.js.format:prettier
: Formats files using the prettier rules defined in .prettierrc.test
: Runs testing using watch mode.test:cov
: Runs testing displaying a coverage report.
Blog Post
I created a post explaning how to set up this library and publish it to a package registry! You can read it here.