https://github.com/html5-ninja/react-web-app
React , Tailwindcss, Storybook boilerplate with Vite
https://github.com/html5-ninja/react-web-app
boilerplate eslint husky prettier react reactjs storybook tailwindcss typescript vite
Last synced: 2 months ago
JSON representation
React , Tailwindcss, Storybook boilerplate with Vite
- Host: GitHub
- URL: https://github.com/html5-ninja/react-web-app
- Owner: html5-ninja
- Created: 2025-01-01T19:33:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-22T20:33:31.000Z (3 months ago)
- Last Synced: 2026-03-23T12:24:00.080Z (3 months ago)
- Topics: boilerplate, eslint, husky, prettier, react, reactjs, storybook, tailwindcss, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 58.6 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Web App
This is a React boilerplate project configured with Vite, TypeScript, ESLint, Prettier, Storybook, and TailwindCSS.
## Getting Started
### Prerequisites
Make sure you have the following installed:
- Node.js (>= 14.x)
- npm (>= 6.x) or yarn (>= 1.x)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/html5-ninja/react-web-app
cd react-web-app
```
2. Install dependencies:
```sh
npm install
# or
yarn install
```
### Scripts
- **Start development server:**
```sh
npm run dev
# or
yarn dev
```
- **Build for production:**
```sh
npm run build
# or
yarn build
```
- **Lint the code:**
```sh
npm run lint
# or
yarn lint
```
- **Format the code:**
```sh
npm run format
# or
yarn format
```
- **Run Storybook:**
```sh
npm run storybook
# or
yarn storybook
```
- **Build Storybook:**
```sh
npm run build-storybook
# or
yarn build-storybook
```
### Project Structure
- `src/`: Source code for the application.
- `public/`: Public assets.
- `.eslintrc.js`: ESLint configuration.
- `prettier.config.js`: Prettier configuration.
- `tsconfig.json`: TypeScript configuration.
- `.storybook/`: Storybook configuration.
### Dependencies
- **React**: A JavaScript library for building user interfaces.
- **Vite**: A fast build tool for modern web projects.
- **TypeScript**: A typed superset of JavaScript.
- **ESLint**: A tool for identifying and fixing problems in JavaScript code.
- **Prettier**: An opinionated code formatter.
- **Storybook**: A tool for developing UI components in isolation.
- **TailwindCSS**: A utility-first CSS framework.
### DevDependencies
- Various plugins and tools for ESLint, Storybook, and TypeScript.
### Configuration
- **ESLint**: Configured to use the recommended settings for Storybook.
- **Prettier**: Configured to format all files in the project.
- **TypeScript**: Configured to work with React and Vite.
## Contributing
Feel free to submit issues and pull requests.
## License
This project is licensed under the MIT License.