Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
LamboCreeper committed May 4, 2024
1 parent 40eed27 commit fd4c59e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Code Review Tool

## Getting Started
1. Set the correct Node version via `nvm use`
2. Start the Firebase Emulators via `npm run dev`
3. In another Terminal, start the React development server by running `npm start` within the `hosting` directory
- In order to authenticate locally, you will need to use `127.0.0.1` rather than `localhost`

## Project Guidelines

### React Query Usage
We use the [React Query](https://tanstack.com/query/latest/docs/framework/react/overview) library for handling caching and synchronisation of our API calls. For consistency, we use the format `[<service-being-called>, <endpoint>, <parameter>]` for our [query keys](https://tanstack.com/query/latest/docs/framework/react/guides/query-keys) (for example: `["github", "repositories", "example-user"]`). We ask that you keep the implementation of [query functions](https://tanstack.com/query/latest/docs/framework/react/guides/query-functions) slim, placing most the logic in the service layer.

0 comments on commit fd4c59e

Please sign in to comment.