Skip to content

Commit 7d15211

Browse files
committed
#54 Checking for readme file format
1 parent b6c3611 commit 7d15211

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,28 @@ All the dependencies used in this project will be listed in the `package.json` f
1313
## Installation
1414

1515
To start working on this project first you need to create `.env` file. This .env file will contain:
16+
1617
`PORT`
1718
You can set it on any port number you want.
19+
1820
`TOKEN_SECRET` which you will get by running following line in terminal
1921
```
2022
node -e "console.log(require('crypto').randomBytes(256).toString('base64'));
2123
```
2224
`ENVIRONMENT`
23-
Set this on 'local'
25+
Set this on 'local'
26+
2427
`DB_URL`
25-
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.
26-
`EMAIL_HOST`
27-
`EMAIL_PORT`
28-
`EMAIL_USER`
29-
`EMAIL_PASS`
30-
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.
31-
32-
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.
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.
29+
30+
`EMAIL_HOST`,
31+
`EMAIL_PORT`,
32+
`EMAIL_USER`,
33+
`EMAIL_PASS`
34+
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.
36+
37+
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.
3338

3439
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.
3540

0 commit comments

Comments
 (0)