README.md

Mailing API

Table of Contents

• Overview
• Getting Started
  • Run Locally
  • Environment Variables
• Tests
  • Unit Tests
• API Documentation

Overview

Mailing API is used to send emails through a mail provider such as MailJet.

Getting Started

Run Locally

1. Obtain a MailJet API key and secret: https://app.mailjet.com/account/apikeys
2. Copy .env.sample to .env and update the values as needed
3. Start the service: docker-compose up --build

Environment Variables

Name	Description
MAILJET_API_KEY	API key obtained from MailJet.
MAILJET_API_SECRET	API secret obtained from MailJet.
MAIL_FROM_ADDRESS	MailJet mail sender address.

Tests

Unit Tests

Run all unit tests:

npm test

Run all unit tests and calculate coverage:

npm run test:cov

API Documentation

• ReDoc