Quickstart

1. Install the dependencies with npm install
2. Run rm -rf node_modules/.vite/deps on a git terminal
3. Create a .env file on the project base folder
4. Add the firebase token to the .env file.
5. Run the application with npm run dev

File Structure 🗂️

• Components contains all generic components that are shared across pages. They should be generic and reusable, and testable in isolation.

• Pages contains our different application views. Generally any requests should be activated here so that any children components don't have to, e.g. If we have a 'User Details' view, we should dispatch our network requests for user information from here.

• Styles consists global style files that should be made available across our application.

Testing ⚗️

• This project utilizes Vitest with React Testing Library (RTL).

• All component folders will have an associated test file within the same folder. Each component is tested independently (unit testing) to ensure they work in isolation and aren't affected by external factors(such as other components).

• Any test that would use the 'render' function from RTL, use the 'customRender' function from testUtils.js. This adds routing by default so we can easily test components that include route/link logic.

  • A example can be seen in src/pages/Home

Code Quality 🌟

• This project uses prettier and ESlint to increase code readability and consistency.

Handover 📃

There is a Handover document in the /doc folder with developer specific information about the project.