https://github.com/marcin-kopanski/react-vite-micro-demo

https://github.com/marcin-kopanski/react-vite-micro-demo

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/marcin-kopanski/react-vite-micro-demo
• Owner: marcin-kopanski
• License: mit
• Created: 2023-10-05T11:30:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-16T15:53:43.000Z (over 1 year ago)
• Last Synced: 2024-11-05T23:19:49.036Z (3 months ago)
• Language: TypeScript
• Size: 851 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-vite-boiler ❤️‍🔥

A modern minimal Vite + React + TypeScript template with pre-configured ESLint, Prettier, Testing with Jest and Git hooks with Husky out of the box 📦

## Features

- ⚡️ [Vite](https://vitejs.dev/) - Next Generation Frontend Tooling

- ⚛️ [React 18](https://reactjs.org/) - A JavaScript library for building user interfaces

- 💎 [TypeScript](https://www.typescriptlang.org/) - Why not?!

- 🔨 [EsLint](https://eslint.org/) - Pluggable JavaScript linter

- 🌀 [Prettier](https://prettier.io) - Opinionated Code Formatter

- 🐺 [Husky](https://github.com/typicode/husky) - Native Git hooks

- ⚙️ [Jest](https://jestjs.io/) - Testing libraries

- ⌨️ Absolute Imports

- 📑 [Commitlint](https://commitlint.js.org/) - Linting your commits based on commit convention

## Usage

```bash

# to clone repository run:

npx degit marcin-kopanski/react-vite-micro-demo my-app

cd my-app

# Required if you want a repository and work with Git hooks

git init

yarn install

yarn dev

```

## Available commands

In this project, you can run the following scripts:


| Script        | Description                                                                 |

| ------------- | --------------------------------------------------------------------------- |

| yarn dev      | Runs the app in the development mode.                                       |

| yarn build    | Builds the app for production to the `dist` folder.                         |

| yarn preview  | Builds the app for production to the `dist` folder, and run locally server. |

| yarn lint     | Runs the Eslint and show code problems                                      |

| yarn lint:fix | Runs the Eslint and fix the code problems                                   |

| yarn format   | Runs the Prettier and fix code style                                        |

| yarn compile  | Runs the TS Compiling                                                       |

| yarn test     | Run the app tests.                                                          |

| yarn commit   | Open the CZ CLI to create a message to your commit.                         |

## License

[MIT](https://choosealicense.com/licenses/mit/)