notify

README

Notify

API docs

Notify is a notifications microservice. It currently supports the following mechanisms and providers:

1. Email
2. Gmail
3. Mandrill
4. SMS
5. Amazon SNS

Adding more types and providers is super simple!

API

Notify exposes a RESTful API. You can read about it in the API Docs

Quick Start

Required environment variables are documented in config/config.go. If you miss one, don't worry, the program will refuse to start and ask for the missing variable.

Notify is published on Dockerhub. That's probably the simplest way to get going with it.

docker pull davidbanham/notify

If you'd like to build it yourself, that's easy too:

make install
make build

The binary will pop out in ./bin/notify

Contributing

We assume that you have glide installed.

To get developing just:

make install
make test

A handy dev server is available via:

docker-compose up dev

Test coverage is minimal, since testing the individual providers would require either a lot of credentials or a lot of mocking. Generally speaking, more tests are better than less tests, but we don't want to make them such a hassle to write and run that they're a net negative.