Skip to content
Snippets Groups Projects
README.md 1.92 KiB
Newer Older
1. Clone the project
2. Run `npm ci` to install the dependencies (a node_modules folder will be created)
3. Run `npm run dev` to start the development server

hannahl8's avatar
hannahl8 committed
Installs in the project:
1. Run `npm i --save @fortawesome/fontawesome-svg-core` to install fontawesome
2. Run `npm install --save @fortawesome/free-solid-svg-icons` to install fontawesome
3. Run `npm install --save @fortawesome/react-fontawesome` to install fontawesome
4. Run `npm install formik --save` to install formik
5. Run `npm install yup --save` to install yup
6. Run `npm install react-confetti` to install confetti
7. Run `npm i --save-dev @types/canvas-confetti` to install types for confetti
hannahl8's avatar
hannahl8 committed

# React + TypeScript + Vite
hannahl8's avatar
hannahl8 committed

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
hannahl8's avatar
hannahl8 committed

Currently, two official plugins are available:
hannahl8's avatar
hannahl8 committed

- [@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
hannahl8's avatar
hannahl8 committed

## Expanding the ESLint configuration
hannahl8's avatar
hannahl8 committed

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
hannahl8's avatar
hannahl8 committed

- Configure the top-level `parserOptions` property like this:
hannahl8's avatar
hannahl8 committed

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

- 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