Skip to content

Commit 82f0cc5

Browse files
chore: install volta and pinned version -yarn,node
1 parent e7118bd commit 82f0cc5

File tree

5 files changed

+7346
-10220
lines changed

5 files changed

+7346
-10220
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing to Real Dev Squad API
22

33
- [Getting Started](#getting-started)
4-
- [NPM Command Reference](#npm-command-reference)
4+
- [Yarn Command Reference](#yarn-command-reference)
55
- [Project Structure](#project-structure)
66
- [Generating Authentication Token](#generating-authentication-token)
77
- [Testing Guidelines](#testing-guidelines)
@@ -12,26 +12,26 @@
1212

1313
Instructions for initial setup can be found in the [README](README.md).
1414

15-
## NPM Command Reference
15+
## Yarn Command Reference
1616

17-
##### `npm install`
17+
##### `yarn`
1818

1919
Installs all `dependencies` listed in the root `package.json`.
2020

21-
##### `npm run test`
21+
##### `yarn run test`
2222

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
2424
repository. This will run the lint, integration and unit tests.
2525

26-
##### `npm run lint`
26+
##### `yarn run lint`
2727

2828
Runs the lint checks in the project.
2929

30-
##### `npm run generate-api-schema`
30+
##### `yarn run generate-api-schema`
3131

3232
Generates the API schema in the file `public/apiSchema.json`.
3333

34-
##### `npm run validate-setup`
34+
##### `yarn run validate-setup`
3535

3636
Runs the test for checking local development setup is working properly or not.
3737

@@ -137,8 +137,8 @@ rds-session-staging
137137
## Running test scripts on Windows
138138
139139
- 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.
142142
- Make sure the server is not running.
143143
- 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.
144144
- For e.g - After running the integration tests, close the emulator window and then run the command for unit tests.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ This Project serves the backend APIs required for [Real Dev Squad](https://reald
1818

1919
## Running the Project
2020
```shell
21-
$ npm install
22-
$ npm start
21+
$ yarn
22+
$ yarn start
2323
```
2424
#### Running in dev mode
2525
```shell
26-
$ npm run dev
26+
$ yarn run dev
2727
```
2828

2929
#### Test local setup
3030
```shell
31-
$ npm run validate-setup
31+
$ yarn run validate-setup
3232
```
3333

3434
## Prerequisites
@@ -44,7 +44,7 @@ $ npm run validate-setup
4444
- You can import the file [API Schema](https://github.com/Real-Dev-Squad/website-backend/blob/develop/public/apiSchema.json) to [Postman](https://www.postman.com/) or [SwaggerHub](https://swagger.io/tools/swaggerhub/).
4545
- If any API changes have been made:
4646
- Write JS Doc on top of your routes using YAML based annotations in OPEN API 3.0 format.
47-
- Run `npm run generate-api-schema` to generate the API schema. A file `public/apiSchema.json` will be created/updated.
47+
- Run `yarn run generate-api-schema` to generate the API schema. A file `public/apiSchema.json` will be created/updated.
4848

4949
Check out our video on how to setup the backend here: [Wiki link](https://github.com/Real-Dev-Squad/website-backend/wiki/Backend-setup-and-understanding-the-flow)
5050

0 commit comments

Comments
 (0)