Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.04 KB

README.md

File metadata and controls

73 lines (54 loc) · 2.04 KB
Raw

ApiTree s.r.o.
ApiTree

🎄 Newsletter 🎄

Build QA

Christmas newsletter built with email-templates, made with ❤️

Merry Chrismtmas

👀 Preview

The preview is available at https://apitreecz.github.io/newsletter/.

💾 Installation

nvm use
yarn install

⚙️ Configuration

Create .env from .env.example

  • DRY_RUN = 1 to run without actually sending, 0 to run normally
  • EMAIL_FROM = email sender in Name <user@domain.tld> format
  • EMAIL_TO = comma-separated list of newsletter recipient email addresses
  • SEND = 1 to send via SMTP server, 0 to render preview in browser
  • SMTP_PASSWORD = password to access the SMTP server
  • SMTP_SERVER = the SMTP server address
  • SMTP_USER = username to access the SMTP server

👨‍💻 Usage

📦 Build

yarn build

✉️ Send

yarn send

To prevent the newsletter being sent multiple times to the same recipient a sent.json will be created. This will contain addresses and dates of sent emails that will be checked if send command is used again.

📄 Render

You can also render the newsletter into an HTML file. This will not send anything regardless the .env config.

yarn render