Skip to content

Commit

Permalink
TESTING
Browse files Browse the repository at this point in the history
  • Loading branch information
ryansurf committed May 22, 2024
1 parent bafac4a commit 2146bf8
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,18 @@ Change `.env.example` to `.env`
| Variable | Description|
| -------- | ------- |
| `PORT=` | The port you want to open to run the application. Default = 8000 |
| `SMTP_SERVER=` | The email server you are using. Default = smtp.gmail.com |
| `EMAIL=` | The email you will send the report from. |
| `EMAIL_PW=` | The sending email's password |
| `EMAIL_RECEIVER=` | The email that will receive the report (your personal email) |
| `COMMAND=` | The command that will be ran and shown in the email. Default = `localhost:8000` |
| `SUBJECT=` | The email's subject. Default = Surf Report |

**Email Server**

Optional, sends a surf report to a specified email.

You will need to setup an email account that is able to utilize SMTP services. I used Gmail, following Method #1 outlined [here](https://www.cubebackup.com/blog/how-to-use-google-smtp-service-to-send-emails-for-free/). After doing this, change the variables in `.env`

## Development

Expand Down

0 comments on commit 2146bf8

Please sign in to comment.