Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alswlfl29 committed Jul 8, 2024
1 parent f42a243 commit 1c8dc96
Showing 1 changed file with 25 additions and 21 deletions.
46 changes: 25 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
# React + TypeScript + Vite
## 시작가이드

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
### Requirements

Currently, two official plugins are available:
For building and running the application you need:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
- [Node.js 21.6.2](https://nodejs.org/en/blog/release/v21.6.2)
- [Yarn 1.22.19](https://www.npmjs.com/package/yarn/v/1.22.19)

## Expanding the ESLint configuration
### Installation

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
1. Clone the repository:

- Configure the top-level `parserOptions` property like this:
```
git clone https://github.com/HanaFun/HanaFun_FE.git
```

2. Install dependencies:

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
};
```
yarn
```

3. Start the development server:

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
```
yarn dev
```

4. Open the project in your browser:

```
http://localhost:3000
```

0 comments on commit 1c8dc96

Please sign in to comment.