Collaborators: Steven Zhu, Vincent Zhang, Ivan Ng, Zhao Zhang

Please create a branch before working on the project, when you're done, make a pull request

List of npm commands

• npm run dev (vite)
• npm run build (tsc -b && vite build)
• npm run lint (eslint)
• npm run preview (vite preview)

Starting a new branch

• git checkout master<
• git pull (<- IMPORTANT, pulls all changes from master)
• git checkout -b "(branch name)" (takes the code that you pulled to main and brings it to a seperate branch)

Only when you're done working on your branch

• git add *
• git commit -m "..."
• git push --set-upstream origin <branch_name>
• Once you finish, make a pull request and allow Zhao to verify and resolve any merge conflicts

Conventions

• Name functions using camelCase (First letter is lowercase, first letter of every word after taht is capitalized)
• Name classes and constructors using PascalCase (First letter of every word is capitialized)
• We should name branches in the format feature/{feature-name} or bugfix/{bug-name}

website will be hosted on vercel

Add Link Here

Sources

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 uses Babel (or oxc when used in rolldown-vite) for Fast Refresh
• @vitejs/plugin-react-swc uses SWC for Fast Refresh

React Compiler

The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see this documentation.

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...

      // Remove tseslint.configs.recommended and replace with this
      tseslint.configs.recommendedTypeChecked,
      // Alternatively, use this for stricter rules
      tseslint.configs.strictTypeChecked,
      // Optionally, add this for stylistic rules
      tseslint.configs.stylisticTypeChecked,

      // Other configs...
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])

You can also install eslint-plugin-react-x and eslint-plugin-react-dom for React-specific lint rules:

// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...
      // Enable lint rules for React
      reactX.configs['recommended-typescript'],
      // Enable lint rules for React DOM
      reactDom.configs.recommended,
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])