Skip to content

Commit af71a31

Browse files
edited
1 parent 2ba3299 commit af71a31

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
1-
# A NodeJs/Express RESTful API for User Authentication + Authorization using MongoDB and Gitpod Docker
2-
Just Simplly run:
1+
###### A NodeJs/Express RESTful API for User Authentication + Authorization using MongoDB and Gitpod Docker
2+
Just Simplly run
3+
```
34
npm install
45
or
56
yarn install
7+
```
68

79
and then run:
10+
```
811
npm start
12+
```
913
------> so the server will be starting on a gitpod docker container and will listening on port 3000, the server will log that:
1014

1115
"Server is running on port 3000.
1216
Successfully connected to MongoDB.".
1317

14-
# NOTE: The backend database is in MongoDB, which is hosted on MongoDB Atlas Cluster, you can find its URL in (app/config/db.config.js). So, if you want to use your own MongoDB, simple put your online cluster url or your mongodb local database URL.
18+
###### NOTE: The backend database is in MongoDB, which is hosted on MongoDB Atlas Cluster, you can find its URL in (app/config/db.config.js). So, if you want to use your own MongoDB, simple put your online cluster url or your mongodb local database URL.
1519

1620

1721
Then you can call RESTful API endpoints;
1822

1923

20-
# The following are the endpoints with their brief description: (you can use POSTMAN or any other api caller....(however, I used PSOTMAN for TESTING)).
21-
24+
###### The following are the endpoints with their brief description: (you can use POSTMAN or any other api caller....(however, I used PSOTMAN for TESTING)).
2225

26+
```
2327
POST: /api/auth/signup
2428
Description: for SignUp/Registeration example request body---> {
2529
"email": "mytest5@gmail.com",
@@ -53,4 +57,5 @@ Description: for Modereator Content Authorization
5357
GET: /api/test/admin
5458
Description: for Admin Content Authorization
5559
authToken + admin role is required (Should be signed in first)
60+
```
5661

0 commit comments

Comments
 (0)