Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.98 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.98 KB

Frontend React

Tagging code style: prettier codecov

Development

Folder structure

Folder Description
src Contains all the source code for the frontend.
src/components Contains all the React components.
src/screens Contains all the pages of the application.
src/context Contains the React Context Providers unless you are using a global state management library like Redux or Zustand.
src/hooks Contains all the custom hooks.
src/services Contains the services that interact with the backend, E.g. Axios, Fetch.

Setup

  1. Install dependencies
npm install
  1. (Optional) Copy the .env.example file to .env and fill in the environment variables in case you need to change the default values.

  2. Run the app

npm run dev

Linter and Formatter

To check for linting errors in your code, run:

npm run lint:check

To automatically fix linting errors in your code (if possible), run:

npm run lint:fix

To check for formatting errors in your code, run:

npm run format:check

To automatically fix formatting errors in your code (if possible), run:

npm run format:fix

Testing

Run:

npm run test

Make sure you have the React app running on localhost:5173 before running the e2e tests.

Coverage

sunburst grid