Skip to content

Commit 061ecd1

Browse files
committed
update readme
1 parent 6175602 commit 061ecd1

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,22 @@ npm run setup
5959
This project includes these forms of Testing:
6060

6161
* **Static Analysis**: catch typos and type errors as you write the code.
62+
6263
[ESLint](https://eslint.org/) statically analyzes your code to quickly find problems. [Prettier](https://prettier.io/) enforces a consistent code style.
6364
This project use [TypeScript](https://www.typescriptlang.org/). By understanding JavaScript, TypeScript saves you time catching errors and providing fixes before you run code.
64-
* **Unit**: verify that individual, isolated parts work as expected.
65-
This application use JavaScript Testing Framework - [Jest](https://jestjs.io/) with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro). Tests live in the `tests` folder next to the file they are testing.
66-
* **Integration**: verify that several units work together in harmony.
67-
Tools for this include the Jest and React Testing Library. Jest also collect code coverage information.
68-
Jest integration tests are written in almost the same way as unit tests, but they all live in the `/tests` root folder.
65+
66+
* **Unit**: verify that individual, isolated parts work as expected.
67+
* **Integration**: verify that several units work together in harmony.
68+
69+
This application use JavaScript Testing Framework - [Jest](https://jestjs.io/) with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro). Tests live in the `tests` folder, when is possible, next to the file they are testing.
70+
Jest also collect code coverage information.
71+
6972
* **End-to-end**: a helper robot that behaves like a user to click around the app and verify that it functions correctly. Sometimes called "functional testing" or e2e.
73+
7074
These tests are written with [cypress](https://www.cypress.io/) and [Cypress Testing Library](https://testing-library.com/docs/cypress-testing-library/intro/). End-to-end tests live in the `cypress/e2e` folder. Use `npm run test:e2e:dev` commands to open and add more tests if you want.
75+
> Note. Change your "baseUrl" in `cypress.json` to `http://localhost:3000` for local testing.
7176
72-
To run all of these tests, please use the following command:
77+
Please, use the following command to run static, unit, and integration tests:
7378

7479
```
7580
npm run validate
@@ -98,13 +103,13 @@ cd server
98103
Then create a virtual environment in which you can install the dependencies:
99104

100105
```
101-
python -m venv env
106+
python -m venv venv
102107
```
103108

104109
Activate a virtual environment:
105110

106111
```
107-
source env/Scripts/activate
112+
source venv/Scripts/activate
108113
```
109114

110115
#### Dependencies
@@ -244,7 +249,7 @@ cd server
244249
```
245250

246251
```
247-
source env/Scripts/activate
252+
source venv/Scripts/activate
248253
```
249254

250255
- run **pytest**:

0 commit comments

Comments
 (0)