David Headrick
45c8eb4095
Added detailed instructions for cloning the project and setting up the development environment, including commands for Git, Node.js installation via nvm for Windows, and verification steps for Node.js and npm versions.
66 lines
2.1 KiB
Markdown
66 lines
2.1 KiB
Markdown
# to clone: in command prompt, go to the directory you want to clone the project to, then type:
|
|
# git clone --branch main https://<your_username_here>@git.surge365.com/Surge365/MassEmailReact.git
|
|
# TO DO IF YOU WANT TO BUILD THIS PROJECT
|
|
# 1) Install node.js v22.13.1
|
|
# 1B) To do this, recommended to install nvm for windows, then in command prompt, type: nvm install 22.13.1
|
|
# 1C) Then type: nvm use 22.13.1
|
|
# 1D) Then to verify type: node -v (should return v22.13.1))
|
|
# 1E) Then to verify type: npm -v (should return a version)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# React + TypeScript + Vite
|
|
|
|
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
|
|
|
|
Currently, two official plugins are available:
|
|
|
|
- [@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,
|
|
},
|
|
},
|
|
})
|
|
```
|
|
|
|
- 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,
|
|
},
|
|
})
|
|
```
|