@@ -338,6 +338,35 @@ yarn run start:local
338
338
339
339
And then you should be able to visit http://localhost:4200!
340
340
341
+ ##### Using Mailgun to Send Emails
342
+
343
+ We currently have email functionality enabled for confirming a user's email
344
+ address. In development, the sending of emails is simulated by a file
345
+ representing the email being created in your local `/tmp/` directory. If
346
+ you want to test sending real emails, you will have to either set the
347
+ Mailgun environment variables in `.env` manually or run your app instance
348
+ on Heroku and add the Mailgun app.
349
+
350
+ To set the environment variables manually, create an account and configure
351
+ Mailgun. [These quick start instructions]
352
+ (http://mailgun-documentation.readthedocs.io/en/latest/quickstart.html)
353
+ might be helpful. Once you get the environment variables for the app, you
354
+ will have to add them to the bottom of the `.env` file. You will need to
355
+ fill in the `MAILGUN_SMTP_LOGIN`, `MAILGUN_SMTP_PASSWORD`, and
356
+ `MAILGUN_SMTP_SERVER` fields.
357
+
358
+ If using Heroku, you should be able to add the app to your instance on your
359
+ dashboard. When your code is pushed and run on Heroku, the environment
360
+ variables should be detected and you should not have to set anything
361
+ manually.
362
+
363
+ In either case, you should be able to check in your Mailgun account to see
364
+ if emails are being detected and sent. Relevant information should be under
365
+ the 'logs' tab on your Mailgun dashboard. To access, if the variables were
366
+ set up manually, log in to your account. If the variables were set through
367
+ Heroku, you should be able to click on the Mailgun icon in your Heroku
368
+ dashboard, which should take you to your Mailgun dashboard.
369
+
341
370
#### Running the backend tests
342
371
343
372
In your `.env` file, set `TEST_DATABASE_URL` to a value that's the same as
0 commit comments