Skip to content

Commit 526d762

Browse files
committed
fix: added emails documentation
1 parent ffa2bec commit 526d762

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/setup-guide.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Gyman - Setup Guide
22

3+
## How to run the server
34
1. Install the dependecies by using the command `npm install`
45

56
2. Compile the project `num run build`
@@ -16,3 +17,16 @@
1617
ADMIN_EMAIL=[email protected]
1718

1819
6. Start the server `npm run dev`
20+
21+
22+
## How to send Emails
23+
This project send emails by smtp. In order to send the email you have to follow these steps
24+
1. Add these variables to your .env file:
25+
```env
26+
GOOGLE_MAIL_HOST=smtp.gmail.com
27+
GOOGLE_MAIL_PORT=465
28+
GOOGLE_MAIL_SECURE=true
29+
30+
GOOGLE_MAIL_PASSWORD=yourPassword
31+
```
32+
NB: In order to be able to send emaild by your personal gmail you have to enable double factor authentication and then create a new 'app password' to use in the variable above.

0 commit comments

Comments
 (0)