⚛️⚡ Vite + React + Typescript Component Library Template

Features

• ⚛️ React 18
• 📚 Storybook 7 - Components preview
• ⏩ Vite - Run and build the project blazingly fast!
• 📐 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

1. Create a new repository using this one as template
2. Clone your repo
3. Install dependencies with pnpm i (first run corepack enable to enable pnpm)
4. 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.

Develop

1. Run pnpm dev to start the server
2. Develop on the local
3. Run pnpm build:lib to build after developing
4. Push changes to the remote repo