|
1 | 1 | # Contributing to Real Dev Squad API
|
2 | 2 |
|
3 | 3 | - [Getting Started](#getting-started)
|
4 |
| -- [NPM Command Reference](#npm-command-reference) |
| 4 | +- [Yarn Command Reference](#yarn-command-reference) |
5 | 5 | - [Project Structure](#project-structure)
|
6 | 6 | - [Generating Authentication Token](#generating-authentication-token)
|
7 | 7 | - [Testing Guidelines](#testing-guidelines)
|
|
12 | 12 |
|
13 | 13 | Instructions for initial setup can be found in the [README](README.md).
|
14 | 14 |
|
15 |
| -## NPM Command Reference |
| 15 | +## Yarn Command Reference |
16 | 16 |
|
17 |
| -##### `npm install` |
| 17 | +##### `yarn` |
18 | 18 |
|
19 | 19 | Installs all `dependencies` listed in the root `package.json`.
|
20 | 20 |
|
21 |
| -##### `npm run test` |
| 21 | +##### `yarn run test` |
22 | 22 |
|
23 |
| -The script associated with `npm run test` will run all tests that ensures that your commit does not break anything in the |
| 23 | +The script associated with `yarn run test` will run all tests that ensures that your commit does not break anything in the |
24 | 24 | repository. This will run the lint, integration and unit tests.
|
25 | 25 |
|
26 |
| -##### `npm run lint` |
| 26 | +##### `yarn run lint` |
27 | 27 |
|
28 | 28 | Runs the lint checks in the project.
|
29 | 29 |
|
30 |
| -##### `npm run generate-api-schema` |
| 30 | +##### `yarn run generate-api-schema` |
31 | 31 |
|
32 | 32 | Generates the API schema in the file `public/apiSchema.json`.
|
33 | 33 |
|
34 |
| -##### `npm run validate-setup` |
| 34 | +##### `yarn run validate-setup` |
35 | 35 |
|
36 | 36 | Runs the test for checking local development setup is working properly or not.
|
37 | 37 |
|
@@ -137,8 +137,8 @@ rds-session-staging
|
137 | 137 | ## Running test scripts on Windows
|
138 | 138 |
|
139 | 139 | - Git Bash is recommended for running test scripts on Windows.
|
140 |
| -- Run `npm run test-integration` for running integration tests. |
141 |
| -- Run `npm run test-unit` for running unit tests. |
| 140 | +- Run `yarn run test-integration` for running integration tests. |
| 141 | +- Run `yarn run test-unit` for running unit tests. |
142 | 142 | - Make sure the server is not running.
|
143 | 143 | - Make sure to close the emulator window after running the tests in order to avoid the blocking of the port for the next tests to run.
|
144 | 144 | - For e.g - After running the integration tests, close the emulator window and then run the command for unit tests.
|
|
0 commit comments