Transactional email microservice
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
docs
infrastructure
schemata
src
tests
var Automated docker build Jun 3, 2017
web
.dockerignore
.gitignore
.travis.yml
Dockerfile Configure docker to run as non-root user (#42) Jul 25, 2018
Dockerfile.docs
LICENSE.md
Procfile
README.md
composer.json
composer.lock
docker-compose.dev.yml
docker-compose.tests.yml
docker-compose.travis.yml
docker-compose.yml
phpunit.xml.dist
test.sh
test_travis.sh

README.md

OutStack Enveloper

Build Status Codacy Badge

We've not yet reached version 1. You're still encouraged to use it, but if you find something amiss let us know. If you're not sure about something, just ask! To keep updated when we release new things, follow us on Twitter

What is it?

Enveloper is a small service intended to be run in your infrastucture to speed up developing and testing transactional emails in your application.

Enveloper GIF Demo

Define your templates using template files and YAML, then send messages using simple API requests.

See Getting Started or browse the rest of this documentation.

Main features

Issues / Roadmap

Enveloper is currently in a workable and useful state, with minimal features. Things on the roadmap can be found at https://github.com/outstack/enveloper/issues . Those marked High Priority are likely to be worked on first.

Create an issue if there's something you'd like to see added, and feel free to tackle any already in the list. Any help is welcomed.

Running the tests / developing Enveloper

There is a helper script in the root of the project, test.sh which will run all the tests. Inspect this file to see how to run a subset of the tests.

Prerequisites:

  • First you must download and install composer into the project root as composer.phar. Give it executable permissions.