README.md

Vite typescript react library template⚡

Create a new react library project with Vite, React JS, TypeScript, Eslint, Prettier in just 1 second and you don't need to setup anything.

Netlify Deploy: https://typescript-react-library-template.netlify.app/

Features 📋

• ⚛️ React 17
• 📚 Jest - Test framework
• ⏩ 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

Using 📦

1. Clone Template

git clone https://github.com/kothing/vite-typescript-react-library-template.git

2. Install Packages

yarn install

3. Start Project

yarn dev

4. If you using git, delete the existing folder .git after cloning (open git bash or other terminal)

rm -rf .git

Options ✍️

The starter contains the following scripts:

• dev - starts dev server
• build - generates the following bundles: CommonJS (.cjs) ES (.es) UMD (.umd.js) and IIFE (.iife.js). The name of bundle is automatically taked from package.json name property
• eslint - lint .js, .jsx, .ts, .tsx files with eslint
• prettier - format .js, .ts, .html and .json files with prettier
• stylelint - format .css less and .scss files with stylelint
• prepare - script for setting up husky pre-commit hook

📋 License

Licensed under the MIT License.