Add info to readme about frontend tests
This commit is contained in:
parent
553e4f3461
commit
a36604ea4b
13
README.md
13
README.md
@ -14,6 +14,7 @@ It shows the CSV data given as a simple grid, where the user can filter based on
|
||||
### Frontend
|
||||
* Vanilla React w/ Vite
|
||||
* React Query - React Router
|
||||
* Testing with Jest and React Testing Framework
|
||||
|
||||
### Development Tools
|
||||
This project was primarily developed on Kubuntu 22.04, but has been tested on Windows 10.
|
||||
@ -93,6 +94,12 @@ npm run build
|
||||
|
||||
This will produce a build that can be deployed (sorry for no instructions on deployment!).
|
||||
|
||||
#### Running Tests
|
||||
To run all of the test suites, navigate to the `./frontend/leeds-beer-quest/` directory and run:
|
||||
```bash
|
||||
npm run test
|
||||
```
|
||||
|
||||
#### Environment Settings
|
||||
|
||||
The `./frontend/leeds-beer-quest/src/lib/environment.ts` file should already contain the correct location for the backend API, however if it does not, you should modify the `BaseAPIUrl` property to be the same path as your backend instance.
|
||||
@ -135,4 +142,8 @@ More for the frontend, but backend doesn't have the best either. More checks mak
|
||||
|
||||
### Add unit tests for FE
|
||||
|
||||
Even if it's just a few, it will show off how I unit test for the frontend.
|
||||
Even if it's just a few, it will show off how I unit test for the frontend.
|
||||
|
||||
### Error loading states
|
||||
|
||||
### Add some comments around
|
Loading…
Reference in New Issue
Block a user