Hello World SME Invoker Service

[nonrtric.git] / sample-services / hello-world / README.md

diff --git a/sample-services/hello-world/README.md b/sample-services/hello-world/README.md
new file mode 100644 (file)
index 0000000..1dd8abc
--- /dev/null
+++ b/sample-services/hello-world/README.md
@@ -0,0 +1,37 @@
+# Hello World Service\r
+\r
+This repository contains a Spring Boot application serving a Hello World endpoint. The application can be built and \r
+run using the provided script - ``hello-world-build-start.sh``.\r
+\r
+## Prerequisites\r
+\r
+- Docker installed on your machine.\r
+\r
+## Building and Running the Application\r
+Run the script:\r
+\r
+```bash\r
+  ./hello-world-build-start.sh\r
+```\r
+\r
+The script will build a Docker image and run a container with the Hello World service. After the container starts, \r
+wait for a few seconds to ensure the Spring Boot application is fully initialized. Next, it will make an HTTP request to the \r
+Hello World endpoint and display the response:\r
+\r
+```bash\r
+  response=$(curl -s http://localhost:8080/helloworld/v1)\r
+  echo "Response from the Hello World endpoint:"\r
+  echo "$response"\r
+```\r
+\r
+To stop and remove the Docker container:\r
+\r
+```bash\r
+  docker stop hello-world\r
+  docker rm hello-world\r
+```\r
+\r
+## Additional Information\r
+\r
+- The Hello World endpoint is available at http://localhost:8080/helloworld/v1.\r
+\r