StevenJW/x-lab-lbq-technical-test
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add info to readme about frontend tests

Browse Source
This commit is contained in:
Stedoss 2022-11-01 21:26:16 +00:00
parent 553e4f3461
commit a36604ea4b
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -14,6 +14,7 @@ It shows the CSV data given as a simple grid, where the user can filter based on
### Frontend ### Frontend
* Vanilla React w/ Vite * Vanilla React w/ Vite
* React Query - React Router * React Query - React Router
* Testing with Jest and React Testing Framework
### Development Tools ### Development Tools
This project was primarily developed on Kubuntu 22.04, but has been tested on Windows 10. 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!). 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 #### 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. 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.
@ -136,3 +143,7 @@ More for the frontend, but backend doesn't have the best either. More checks mak
### Add unit tests for FE ### 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