Skip to content

Commit e360bf7

Browse files
committed
#54 typo fix, added instruction to run setup.js
1 parent 3745099 commit e360bf7

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ All the dependencies used in this project will be listed in the `package.json` f
1515
To start working on this project first you need to create `.env` file. This .env file will contain:
1616

1717
`PORT`
18-
You can set it on any port number you want.
18+
You can set it on any port number you want. `eg: 4000`
1919

2020
`TOKEN_SECRET` which you will get by running following line in terminal
2121
```
@@ -25,18 +25,23 @@ node -e "console.log(require('crypto').randomBytes(256).toString('base64'));
2525
Set this on 'local'
2626

2727
`DB_URL`
28-
For this parameter you will need to open you account on MongoDB Atlas, don't forget to note down you account password, then create new cluster and through that you will get your connection string which will be your DB_URL in .env, make sure instead of "password" in connection string, you enter your own account password.
28+
For this parameter you will need to open your account on MongoDB Atlas, don't forget to note down you account password, then create new cluster and through that you will get your connection string which will be your DB_URL in .env, make sure instead of "password" in connection string, you enter your own account password.
2929

3030
`EMAIL_HOST`,
3131
`EMAIL_PORT`,
3232
`EMAIL_USER`,
3333
`EMAIL_PASS`
3434

35-
For these above parameters first you need to open an account on any SMTP server, we use mailtrap, then start testing where you will see show credentials in which you will get all the values we need which are host, port, username and password.
35+
For these above parameters, first you need to open an account on any SMTP server, we use mailtrap, then start testing where you will see show credentials in which you will get all the values we need which are host, port, username and password.
3636

3737
You don't need to assign values to these parameters in double or single quotes, just write directly, .env automatically converts it into quoted string.
3838

39-
Once you are done with this, install the packages through `npm ci` which stands for clean install and run the server with `npm run serverstart` or `npm run serverstartWin` depending on your operating system.
39+
Once you are done with this, install the packages through `npm ci` which stands for clean install.
40+
Also, you need to run 'setup.js' file. You can do that by running following command in your terminal
41+
```
42+
node setup.js
43+
```
44+
And finally, run the server with `npm run serverstart` or `npm run serverstartWin` depending on your operating system.
4045

4146
## How to Contribute
4247

0 commit comments

Comments
 (0)