Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add admin mailer. #103

Merged
merged 30 commits into from
Jul 25, 2024
Merged

Add admin mailer. #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
fad94df
Add admin mailer.
scosman Jul 25, 2024
a70edfa
Add docs for admin mailer
scosman Jul 25, 2024
14d3ca9
Make nodemailer optional, see if this fixed cloudflare
scosman Jul 25, 2024
bbda648
Move nodemailer types to dev only dep
scosman Jul 25, 2024
1074e5c
Handle exception on nodemailer import
scosman Jul 25, 2024
e5484da
remove nodemailer from package.lock
scosman Jul 25, 2024
d12ea05
Add cloudflare worker support
scosman Jul 25, 2024
0a6a2da
Nodemailer defined on CF?
scosman Jul 25, 2024
f1e4067
test CF
scosman Jul 25, 2024
62f4df1
test CF
scosman Jul 25, 2024
f0fc32a
test CF
scosman Jul 25, 2024
31071b1
test CF
scosman Jul 25, 2024
ebd2e1e
test CF
scosman Jul 25, 2024
f5f8307
test CF
scosman Jul 25, 2024
07421de
test CF
scosman Jul 25, 2024
97799c6
test CF
scosman Jul 25, 2024
237850b
test CF
scosman Jul 25, 2024
accb4c4
test CF
scosman Jul 25, 2024
b136506
test CF
scosman Jul 25, 2024
428b3a5
test CF
scosman Jul 25, 2024
468ef61
test CF
scosman Jul 25, 2024
552fe69
test CF
scosman Jul 25, 2024
84e1b13
test CF
scosman Jul 25, 2024
1f1a017
test CF
scosman Jul 25, 2024
81585f7
test CF
scosman Jul 25, 2024
1568777
test CF
scosman Jul 25, 2024
3b8defc
test CF
scosman Jul 25, 2024
04be4e3
test CF
scosman Jul 25, 2024
1fbd525
test CF
scosman Jul 25, 2024
6eb3369
test CF
scosman Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,18 @@ If you prefer another host you can explore alternatives:
- [Community adapters](https://sveltesociety.dev/components#adapters) including Github pages, AppEngine, Azure, and more
- [Supabase](https://supabase.com/docs/guides/getting-started/quickstarts/sveltekit) if you want one host for everything. Note: they do charge $10 a month for custom domains, unlike Cloudflare.

## Setup Admin Emailer -- Optional
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix grammatical error: "Setup" should be "Set up".

The word "setup" is a noun. The verb form is "set up".

-## Setup Admin Emailer -- Optional
+## Set Up Admin Emailer -- Optional
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Setup Admin Emailer -- Optional
## Set Up Admin Emailer -- Optional


SaaS Starter includes an admin emailer for sending yourself email notifications when important events happen. This let's you monitor your app and respond to users without watching the database.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix grammatical error: "setup" should be "set up".

The word "setup" is a noun. The verb form is "set up".

-If you setup the admin emailer, it will email you when users create their profile, or when the 'Contact Us' form is submitted.
+If you set up the admin emailer, it will email you when users create their profile, or when the 'Contact Us' form is submitted.

Committable suggestion was skipped due to low confidence.


If you setup the admin emailer, it will email you when users create their profile, or when the 'Contact Us' form is submitted. You can add additional calls to sendAdminEmail() for any other events you want to monitor.

To setup, set these environment variables:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix grammatical error: "setup" should be "set up".

The word "setup" is a noun. The verb form is "set up".

-To setup, set these environment variables:
+To set up, set these environment variables:
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
To setup, set these environment variables:
To set up, set these environment variables:
Tools
LanguageTool

[grammar] ~280-~280: The word “setup” is a noun. The verb is spelled with a space.
Context: ...y other events you want to monitor. To setup, set these environment variables: - `P...

(NOUN_VERB_CONFUSION)


- `PRIVATE_ADMIN_EMAIL`: the email address to which admin emails will be sent.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix punctuation issue: Remove loose punctuation mark.

The colon after "PRIVATE_ADMIN_EMAIL" is unnecessary.

-`PRIVATE_ADMIN_EMAIL`: the email address to which admin emails will be sent.
+`PRIVATE_ADMIN_EMAIL` - the email address to which admin emails will be sent.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `PRIVATE_ADMIN_EMAIL`: the email address to which admin emails will be sent.
- `PRIVATE_ADMIN_EMAIL` - the email address to which admin emails will be sent.
Tools
LanguageTool

[uncategorized] ~282-~282: Loose punctuation mark.
Context: ...ment variables: - PRIVATE_ADMIN_EMAIL: the email address to which admin emails...

(UNLIKELY_OPENING_PUNCTUATION)

- `PRIVATE_FROM_ADMIN_EMAIL`: the email address to use as the from address for admin emails (defaults to `PRIVATE_ADMIN_EMAIL` if not set).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix punctuation issue: Remove loose punctuation mark.

The colon after "PRIVATE_FROM_ADMIN_EMAIL" is unnecessary.

-`PRIVATE_FROM_ADMIN_EMAIL`: the email address to use as the from address for admin emails (defaults to `PRIVATE_ADMIN_EMAIL` if not set).
+`PRIVATE_FROM_ADMIN_EMAIL` - the email address to use as the from address for admin emails (defaults to `PRIVATE_ADMIN_EMAIL` if not set).
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `PRIVATE_FROM_ADMIN_EMAIL`: the email address to use as the from address for admin emails (defaults to `PRIVATE_ADMIN_EMAIL` if not set).
- `PRIVATE_FROM_ADMIN_EMAIL`: the email address to use as the from address for admin emails (defaults to `PRIVATE_ADMIN_EMAIL` if not set).
Tools
LanguageTool

[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...ll be sent. - PRIVATE_FROM_ADMIN_EMAIL: the email address to use as the from ad...

(UNLIKELY_OPENING_PUNCTUATION)

- `PRIVATE_RESEND_API_KEY`: a https://resend.com API key. Note, you'll need to verify your domain with them before you can use their service.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix Markdown issue: Use link syntax for bare URL.

The URL should be formatted as a link.

-`PRIVATE_RESEND_API_KEY`: a https://resend.com API key. Note, you'll need to verify your domain with them before you can use their service.
+`PRIVATE_RESEND_API_KEY` - an [https://resend.com](https://resend.com) API key. Note, you'll need to verify your domain with them before you can use their service.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `PRIVATE_RESEND_API_KEY`: a https://resend.com API key. Note, you'll need to verify your domain with them before you can use their service.
`PRIVATE_RESEND_API_KEY` - an [https://resend.com](https://resend.com) API key. Note, you'll need to verify your domain with them before you can use their service.
Tools
LanguageTool

[uncategorized] ~284-~284: Loose punctuation mark.
Context: ... if not set). - PRIVATE_RESEND_API_KEY: a https://resend.com API key. Note, you...

(UNLIKELY_OPENING_PUNCTUATION)

Markdownlint

284-284: null
Bare URL used

(MD034, no-bare-urls)

Fix punctuation issue: Remove loose punctuation mark.

The colon after "PRIVATE_RESEND_API_KEY" is unnecessary.

-`PRIVATE_RESEND_API_KEY`: a https://resend.com API key. Note, you'll need to verify your domain with them before you can use their service.
+`PRIVATE_RESEND_API_KEY` - a https://resend.com API key. Note, you'll need to verify your domain with them before you can use their service.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `PRIVATE_RESEND_API_KEY`: a https://resend.com API key. Note, you'll need to verify your domain with them before you can use their service.
`PRIVATE_RESEND_API_KEY` - a https://resend.com API key. Note, you'll need to verify your domain with them before you can use their service.
Tools
LanguageTool

[uncategorized] ~284-~284: Loose punctuation mark.
Context: ... if not set). - PRIVATE_RESEND_API_KEY: a https://resend.com API key. Note, you...

(UNLIKELY_OPENING_PUNCTUATION)

Markdownlint

284-284: null
Bare URL used

(MD034, no-bare-urls)


## Add Your Content

After the steps above, you’ll have a working version like the demo page. However, it’s not branded, and doesn’t have your content. The following checklist helps you customize the template to make a SaaS homepage for your company.
Expand Down
8 changes: 8 additions & 0 deletions local_env_template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Supabase settings
PUBLIC_SUPABASE_URL='https://REPLACE_ME.supabase.co'
PUBLIC_SUPABASE_ANON_KEY='REPLACE_ME'
PRIVATE_SUPABASE_SERVICE_ROLE='REPLACE_ME'

# Stripe settings
PRIVATE_STRIPE_API_KEY='REPLACE_ME'

# settings for email - optional
# PRIVATE_ADMIN_EMAIL='[email protected]'
# PRIVATE_FROM_ADMIN_EMAIL='REPLACE_ME'
# PRIVATE_RESEND_API_KEY='REPLACE_ME'
Loading
Loading