emailer-js-api
v1.0.2
Published
a RESTful API that accepts the necessary information and sends emails via the `emailer-js` npm package
Downloads
6
Readme
Email Service API
a RESTful API that accepts the necessary information and sends emails
using emailer-js
Getting Started
Prerequisites
nodejs
Setup Environment Variables
Update the development environment with your email service API keys
e.g. [SENDGRID_API_KEY] on (https://app.sendgrid.com/settings/api_keys)
echo "
export SENDGRID_API_KEY='YOUR_SENDGRID_API_KEY'
export MAILGUN_API_KEY='YOUR_MAILGUN_API_KEY'
export MAILGUN_DOMAIN='YOUR_MAILGUN_DOMAIN'
export SES_ACCESS_KEY='YOUR_SES_ACCESS_KEY'
export SES_SECRET_KEY='YOUR_SES_SECRET_KEY'
" > emailer.env
echo "emailer.env" >> .gitignore
source ./emailer.env
Installing
npm install --save emailer-js-api
Running the tests
You need to set the NODE_ENV environment variable to 'test' and install devDependencies before you run test
npm test
Usage
Run
npm start
Open http://127.0.0.1:3000/
Click "Send Email" on nav menu
Input correct email information then click "Send" button
TODO
- UI Improvement
- More Test Cases
- Host
Authors
- Amanda Xiang - Initial work - Amanda Xiang
See also the list of contributors who participated in this project.