Skip to content

README.md

Latest commit

 

History

History
71 lines (50 loc) · 1.58 KB

README.md

File metadata and controls

71 lines (50 loc) · 1.58 KB

A Local Interface to Manage Your Subscriptions and Send Emails with Postmark and Node.js

This is a REST API built to be used locally on your machine to manage subscribers from your mailing list (MongoDB Collection) and send Broadcast Emails using the Postmark API.

Features

  • Retrieve Subscribers Collection from MongoDB.
  • Send Preview Email to one Address. Could be your own, or postmark's test address.
  • Send Broadcast Email to all Subscribers of MongoDB Collection.
  • Switch between MongoDB Collections.

Status: In Progress ⏳

Built with

  • Vanilla JavaScript
  • HTML
  • Bootstrap
  • Axios
  • Express
  • Mongoose
  • MongoDB
  • Node.js
  • Postmark

Usage

Install Dependencies and Run

git clone https://github.com/LaSav/postmark-interface
npm install
npm run server

Env Variables

Create a .env file in the root directory and add the variables:

NODE_ENV = development
PORT = 3000
MONGO_URI = Your MongoDB URI
POSTMARK_KEY = Your Postmark API key

Checklist:

Backend

  • GET Subscribers 👌
  • POST Broadcast 👌
  • GET Broadcasts 👌

Frontend

  • GET Subscribers 👌
  • POST Broadcast 👌
  • GET Broadcasts 👌
  • Errors 👌
  • Send Preview 👌
  • Input Template Number Validation
  • Select between MongoDB Collections

Additional Resources

Postmark Developer Guide

Need to Store Subscribers and Send Transactional Emails? Check out:

REST API to Send Transactional Emails With Postmark and Node.js