Merge pull request #78 from NashTech-Labs/feature/Added-readme

Added readme for payment service
NashTech-Labs · Jan 17, 2024 · b3fc5a1 · b3fc5a1
2 parents 3d2e078 + e99651f
commit b3fc5a1
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ The listed services are operate sequentially.
 - admin-service
 - inventory-service 
 - order-service  [README.md](order-service%2FREADME.md) 
-- payment-service  
+- payment-service  [README.md](payment-service/README.md)
 - shipment-service 
 - elasticsearch
 

diff --git a/documentation/payment-application-config.png b/documentation/payment-application-config.png
diff --git a/payment-service/README.md b/payment-service/README.md
@@ -0,0 +1,17 @@
+# Payment Service
+Payment Service Involves the user verification, and settlement of transactions and on the basis of that executes the PaymentCancelEvent or PaymentApprovedEvent.
+
+## Prerequisites
+We must set up Axon Server to handle command and query operations, and configure MySQL as the persistent store destination.
+
+![payment-application-config.png](../documentation/payment-application-config.png)
+
+## Local setup
+- Setup axon-server and MySQL docker images
+```
+local-dev > docker compose up -d
+```
+- Run the application
+```
+payment-service > mvn clean springboot:run 
+```