Skip to content

Commit

Permalink
Update Readme and vite config
Browse files Browse the repository at this point in the history
  • Loading branch information
kotsiossp97 committed Mar 8, 2024
1 parent 3f50acb commit 01fbbee
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 26 deletions.
34 changes: 8 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,12 @@
# React + TypeScript + Vite
# SimRacing FOV Calculator

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
This is a simple React Application for calculating the correct FOV setting for various sim racing games.

Currently, two official plugins are available:
Calculations are referenced from [dinex86/FOV-Calculator](https://github.com/dinex86/FOV-Calculator).

- [@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
### Under the hood
- Vite React project with Typescript
- shadcn/ui components with Tailwind CSS
- SASS (SCSS) css preprocesssor

## 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 {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```

- 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
![App Screenshot](https://raw.githubusercontent.com/kotsiossp97/simracing-fov-calculator/main/screenshots/screen1.png)
1 change: 1 addition & 0 deletions vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ export default defineConfig({
"@": path.resolve(__dirname, "./src"),
},
},
base: "/simracing-fov-calculator/"
})

0 comments on commit 01fbbee

Please sign in to comment.