summaryrefslogtreecommitdiff
path: root/src/fraud-detection/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/fraud-detection/README.md')
-rw-r--r--src/fraud-detection/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/fraud-detection/README.md b/src/fraud-detection/README.md
new file mode 100644
index 0000000..c844776
--- /dev/null
+++ b/src/fraud-detection/README.md
@@ -0,0 +1,21 @@
+# Fraud Detection Service
+
+This service receives new orders by a Kafka topic and returns cases which are
+suspected of fraud.
+
+## Local Build
+
+To build the protos and the service binary, run from the repo root:
+
+```sh
+cp -r ../../pb/ src/main/proto/
+./gradlew shadowJar
+```
+
+## Docker Build
+
+To build using Docker run from the repo root:
+
+```sh
+docker build -f ./src/fraud-detection/Dockerfile .
+```