summaryrefslogtreecommitdiff
path: root/src/checkout/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/checkout/README.md')
-rw-r--r--src/checkout/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/src/checkout/README.md b/src/checkout/README.md
new file mode 100644
index 0000000..28064bd
--- /dev/null
+++ b/src/checkout/README.md
@@ -0,0 +1,36 @@
+# Checkout Service
+
+This service provides checkout services for the application.
+
+## Local Build
+
+To build the service binary, run:
+
+```sh
+go build -o /go/bin/checkout/
+```
+
+## Docker Build
+
+From the root directory, run:
+
+```sh
+docker compose build checkout
+```
+
+## Regenerate protos
+
+To build the protos, run from the root directory:
+
+```sh
+make docker-generate-protobuf
+```
+
+## Bump dependencies
+
+To bump all dependencies run:
+
+```sh
+go get -u -t ./...
+go mod tidy
+```