https://github.com/rayyamhk/vite-react-component-library-starter

Starter template for React component library
https://github.com/rayyamhk/vite-react-component-library-starter

Last synced: 1 day ago
JSON representation

Starter template for React component library

• Host: GitHub
• URL: https://github.com/rayyamhk/vite-react-component-library-starter
• Owner: rayyamhk
• License: mit
• Created: 2023-12-16T07:38:35.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2023-12-17T06:20:25.000Z (11 months ago)
• Last Synced: 2024-08-02T19:36:29.385Z (3 months ago)
• Language: TypeScript
• Size: 141 KB
• Stars: 30
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-vite - vite-react-component-library-starter - A starter template for creating React component libraries with `TypeScript`, `Tailwind CSS`, `Storybook`, `Vitest`, `ESLint`, `Prettier`, `Husky`, and `GitHub Action`. (Get Started / Templates)
• awesome-vite - vite-react-component-library-starter - A starter template for creating React component libraries with `TypeScript`, `Tailwind CSS`, `Storybook`, `Vitest`, `ESLint`, `Prettier`, `Husky`, and `GitHub Action`. (Get Started / Templates)
• jimsghstars - rayyamhk/vite-react-component-library-starter - Starter template for React component library (TypeScript)

README

        
# Vite React Component Library Starter

This is a starter template for creating React component libraries using Vite. It includes a robust set of features to help you develop, test, and build your library efficiently.

## Features

- React: A JavaScript library for web and native user interfaces.

- TypeScript: A strongly typed superset of JavaScript.

- Tailwind: A utility-first CSS framework.

- Storybook: A frontend workshop for building UI components and pages in isolation.

- Vite: A next generation frontend tooling that runs and builds your library incredibly fast.

- Vitest: A next generation testing framework.

- ESLint: A tool that finds and fixes problems in your code.

- Prettier: A code formatter.

- Husky: A pre-commit hook.

- Github Action: A tool that deploys your Storybook to GitHub page automatically.

## Get Started

1. Clone this repository

2. Install dependencies using `npm i` (or `pnpm i` if you like)

## 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`: Formats your code with Prettier.

## License

MIT