From f5d2c2aabdc9665d393dddb69770ff4c62a88859 Mon Sep 17 00:00:00 2001 From: Tyler Myracle Date: Sun, 14 Jan 2024 13:58:32 -0600 Subject: [PATCH] update readme with postmark instructions --- .env.example | 1 - README.md | 2 ++ 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.env.example b/.env.example index 0220d01b..c112c293 100644 --- a/.env.example +++ b/.env.example @@ -23,7 +23,6 @@ NX_CONVERTKIT_SECRET= NEXT_PUBLIC_ZAPIER_FEEDBACK_HOOK_URL= # Email credentials -POSTMARK_SMTP_PASS= NX_POSTMARK_FROM_ADDRESS=account@example.com NX_POSTMARK_REPLY_TO_ADDRESS=support@example.com NX_POSTMARK_API_TOKEN= diff --git a/README.md b/README.md index d2e47717..3fb87978 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,8 @@ cp .env.example .env Then, create a new secret using `openssl rand -base64 32` and populate `NEXTAUTH_SECRET` in your `.env` file with it. +To enable transactional emails, you'll need to create a [Postmark](https://postmarkapp.com/) account and add your API key to your `.env` file (`NX_POSTMARK_API_TOKEN`). You can also set the from and reply-to email addresses (`NX_POSTMARK_FROM_ADDRESS` and `NX_POSTMARK_REPLY_TO_ADDRESS`). If you want to run the app without email, you can set `NX_POSTMARK_API_TOKEN` to a dummy value. + Then run the following yarn commands: ```