summaryrefslogtreecommitdiff
path: root/src/email/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/email/README.md')
-rw-r--r--src/email/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/email/README.md b/src/email/README.md
new file mode 100644
index 0000000..13533d8
--- /dev/null
+++ b/src/email/README.md
@@ -0,0 +1,23 @@
+# Email Service
+
+The Email service "sends" an email to the customer with their order details by
+rendering it as a log message. It expects a JSON payload like:
+
+```json
+{
+ "email": "some.address@website.com",
+ "order": "<serialized order protobuf>"
+}
+```
+
+## Local Build
+
+We use `bundler` to manage dependencies. To get started, simply `bundle install`.
+
+## Running locally
+
+You may run this service locally with `bundle exec ruby email_server.rb`.
+
+## Docker Build
+
+From `src/email`, run `docker build .`