You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-9
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,16 @@ Simple node js api project with jwt authentication with mongodb.
5
5
6
6
This is assumed that npm, node and mongodb are installed on the machine.
7
7
8
-
* node js >= 6.9.x
9
-
* npm >= 3.x.x
8
+
* node js >= 8.x
9
+
* npm >= 5.x
10
10
* mongodb >= 3.2.x
11
-
11
+
12
12
For installing node and npm please refer [here](https://nodejs.org/en/download/package-manager/).
13
13
For installing mongodb [here](https://docs.mongodb.com/manual/installation/).
14
14
15
+
> Note: I recommended to use npm@5, Because it provides `npm audit` facility to check vulnerability in your dependencies.
16
+
17
+
15
18
## Installation and Run
16
19
17
20
1. Clone the repository and move to cloned directory and hit:
@@ -30,12 +33,21 @@ For installing mongodb [here](https://docs.mongodb.com/manual/installation/).
30
33
npm start
31
34
```
32
35
33
-
This will start the project.
36
+
This will start the project on the port number as you specify in `.env` file. Default is `4040`, so you API is now on [https://localhost:4040](http://localhost:4040) url.
37
+
38
+
39
+
## Configuration
34
40
35
-
## Disable JWT
41
+
1. Configuration application using `.env` file by setting environment variable.
42
+
43
+
2. Disable JWT authentication
44
+
45
+
By commenting following line you can disabled JWT verification in index.js.
0 commit comments