summaryrefslogtreecommitdiff
path: root/src/quote/README.md
diff options
context:
space:
mode:
authorSaumit <justsaumit@protonmail.com>2025-09-27 02:14:26 +0530
committerSaumit <justsaumit@protonmail.com>2025-09-27 02:14:26 +0530
commit82e03978b89938219958032efb1448cc76baa181 (patch)
tree626f3e54d52ecd49be0ed3bee30abacc0453d081 /src/quote/README.md
Initial snapshot - OpenTelemetry demo 2.1.3 -f
Diffstat (limited to 'src/quote/README.md')
-rw-r--r--src/quote/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/src/quote/README.md b/src/quote/README.md
new file mode 100644
index 0000000..e1deaff
--- /dev/null
+++ b/src/quote/README.md
@@ -0,0 +1,46 @@
+# Quote Service
+
+The Quote Service calculates the shipping costs,
+based on the number of items to be shipped.
+
+It is a PHP based service, using a combination of automatic and manual instrumentation.
+
+## Docker Build
+
+To build the quote service, run the following from root directory
+of opentelemetry-demo
+
+```sh
+docker compose build quote
+```
+
+## Run the service
+
+Execute the below command to run the service.
+
+```sh
+docker compose up quote
+```
+
+In order to get traffic into the service you have to deploy
+the whole opentelemetry-demo.
+
+Please follow the root README to do so.
+
+## Development
+
+To build and run the quote service locally:
+
+```sh
+docker build src/quote --target base -t quote
+cd src/quote
+docker run --rm -it -v $(pwd):/var/www -e QUOTE_PORT=8999 -p "8999:8999" quote
+```
+
+Then, send some curl requests:
+
+```sh
+curl --location 'http://localhost:8999/getquote' \
+--header 'Content-Type: application/json' \
+--data '{"numberOfItems":3}'
+```