Add README

This commit is contained in:
powermaker450 2024-09-12 00:24:46 -04:00
parent bd665163b5
commit fdee706d1f

View file

@ -1,50 +1,19 @@
# React + TypeScript + Vite
# Simple Review Client
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
This is the client to complete the pair with [Simple Review Server](https://git.povario.com/powermaker450/simple-review-server).
Currently, two official plugins are available:
## Building and Testing
- [@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
## Expanding the ESLint configuration
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
- Configure the top-level `parserOptions` property like this:
```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
})
Clone the repository:
```bash
git clone https://git.povario.com/powermaker450/simple-review-client
```
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
- Optionally add `...tseslint.configs.stylisticTypeChecked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
Install the dependencies and run the dev server:
```bash
pnpm i
```js
// eslint.config.js
import react from 'eslint-plugin-react'
export default tseslint.config({
// Set the react version
settings: { react: { version: '18.3' } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
},
})
pnpm dev
```
Check it out on [http://localhost:5173](http://localhost:5173) and use it to post some reviews to the server!