Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fishylunar committed Nov 25, 2024
1 parent ea76e52 commit bbdeda3
Showing 1 changed file with 22 additions and 43 deletions.
65 changes: 22 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,29 @@
# React + TypeScript + Vite
<div align="center">
<img width=92 src="https://github.com/fishylunar/Thor/blob/ea76e52040f623635e673a74b7021af891811333/public/icon-192.png?raw=true" alt="Thor" title="Thor"/>
</div>

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

Currently, two official plugins are available:
A web application for viewing danish first responder messages.

- [@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
Try it out! - https://fishylunar.github.io/thor

## Expanding the ESLint configuration
<br>

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
<div align="center">
<code><img width="50" src="https://user-images.githubusercontent.com/25181517/183568594-85e280a7-0d7e-4d1a-9028-c8c2209e073c.png" alt="Node.js" title="Node.js"/></code>
<code><img width="50" src="https://user-images.githubusercontent.com/25181517/183890598-19a0ac2d-e88a-4005-a8df-1ee36782fde1.png" alt="TypeScript" title="TypeScript"/></code>
<code><img width="50" src="https://github-production-user-asset-6210df.s3.amazonaws.com/62091613/261395532-b40892ef-efb8-4b0e-a6b5-d1cfc2f3fc35.png" alt="Vite" title="Vite"/></code>
<code><img width="50" src="https://user-images.githubusercontent.com/25181517/183897015-94a058a6-b86e-4e42-a37f-bf92061753e5.png" alt="React" title="React"/></code>
<code><img width="50" src="https://user-images.githubusercontent.com/25181517/202896760-337261ed-ee92-4979-84c4-d4b829c7355d.png" alt="Tailwind CSS" title="Tailwind CSS"/></code>
<code><img width="50" src="https://github.com/user-attachments/assets/e4bd419a-2a4a-459a-ba9a-d3324e693c4d" alt="ShadCn UI" title="ShadCn UI"/></code>
</div>

- Configure the top-level `parserOptions` property like this:
## Technologies Used

```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
})
```

- 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:

```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,
},
})
```
- React for the frontend
- Vite as the build tool
- Tailwind CSS for styling
- TypeScript
- shadcn/ui
- Data source: http://www.odin.dk/112puls/

0 comments on commit bbdeda3

Please sign in to comment.