summaryrefslogtreecommitdiff
path: root/src/accounting/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/accounting/README.md')
-rw-r--r--src/accounting/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/accounting/README.md b/src/accounting/README.md
new file mode 100644
index 0000000..cfaa25b
--- /dev/null
+++ b/src/accounting/README.md
@@ -0,0 +1,33 @@
+# Accounting Service
+
+This service consumes new orders from a Kafka topic.
+
+## Local Build
+
+To build the service binary, navigate to the root directory of the project and run:
+
+```sh
+make generate-protobuf
+```
+
+Navigate back to `src/accounting` and execute:
+
+```sh
+dotnet build
+```
+
+## Docker Build
+
+From the root directory, run:
+
+```sh
+docker compose build accounting
+```
+
+## Bump dependencies
+
+To bump all dependencies run in Package manager:
+
+```sh
+Update-Package -ProjectName Accounting
+```