diff --git a/README.md b/README.md index 98cbf5c8..342c03a6 100644 --- a/README.md +++ b/README.md @@ -271,6 +271,16 @@ 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 + +SaaS Starter includes an admin emailer for sending yourself email notifications when important events happen, such as a new user creating their profile. This let's you monitor your app and respond to users without watching the database. + +Provide email SMTP credientials in your environment variables: `PRIVATE_SMTP_HOST`, `PRIVATE_SMTP_PORT`, `PRIVATE_SMTP_USER`, `PRIVATE_SMTP_PASS`. You can use any SMTP providers such as Gmail, Sendgrid, AWS SES, Resend, or Mailgun. + +Set the email address which admil emails will be sent to in `PRIVATE_ADMIN_EMAIL`. + +You can add additional calls to sendAdminEmail() for any other events you want to monitor. + ## 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. diff --git a/local_env_template b/local_env_template index fadeee14..667774aa 100644 --- a/local_env_template +++ b/local_env_template @@ -1,4 +1,14 @@ +# 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' + +# SMTP settings for email - optional +# PRIVATE_ADMIN_EMAIL='your_email@example.com' # see lib/admin_mailer.ts +# PRIVATE_SMTP_HOST='REPLACE_ME' +# PRIVATE_SMTP_PORT='587' +# PRIVATE_SMTP_USER='REPLACE_ME' +# PRIVATE_SMTP_PASS='REPLACE_ME' \ No newline at end of file