Merge pull request #61 from JavatoDev-com/59-update-readme-with-running-local-setup

readme updates

Author: chinthaka-dinadasa

README.md

@@ -11,6 +11,59 @@ In this article series I’m going to explain using internet banking API concept
 - [1.0.0](https://github.com/JavatoDev-com/internet-banking-concept-microservices/releases/tag/v.1.0.0) - Initial release with Java 11 and Spring Boot 2.
 - [2.0.0](https://github.com/JavatoDev-com/internet-banking-concept-microservices/releases/tag/v.1.0.0) - Updated version with Java 21, Spring Boot 3.2.4 , Spring Cloud 2023.0.0
 
+### Installation
+
+1. Clone the repository:
+
+```shell
+$ git clone https://github.com/JavatoDev-com/internet-banking-concept-microservices.git
+```
+
+2. Navigate to the docker-compose folder:
+
+```shell
+$ cd internet-banking-concept-microservices/docker-compose
+```
+3. Start application using docker-compose:
+
+```shell
+$ docker-compose up -d
+```
+
+#### Docker Containers
+
+Container | IP | Port Mapping |
+--- | --- | --- |
+openzipkin_server | 172.25.0.12 | 9411
+keycloak_web | 172.25.0.11 | 8080
+keycloak_postgre_db | 172.25.0.10 | 5432(Closed Port)
+mysql_javatodev_app | 172.25.0.9 | 3306
+internet-banking-config-server | 172.25.0.8 | 8090
+internet-banking-service-registry | 172.25.0.7 | 8081
+internet-banking-api-gateway | 172.25.0.6 | 8082
+internet-banking-user-service | 172.25.0.5 | 8083
+internet-banking-fund-transfer-service | 172.25.0.4 | 8084
+internet-banking-utility-payment-service | 172.25.0.3 | 8085
+core-banking-service | 172.25.0.2 | 8092
+
+### Postman Collection
+
+Whole suite related postman collection can be sync using this URL. 
+
+[Postman Collection](https://www.postman.com/javatodev-api/workspace/javatodev-api-collections/folder/24962357-0fecb63e-fa48-4a0d-91ba-6b7fdc5ddebd?action=share&source=copy-link&creator=24962357&ctx=documentation)
+
+Clone this postman collection and switch to the `LOCAL_DOCKER_SETUP` Environment.
+
+#### Test Data
+
+By default we have dummy accounts details with user details under core-banking-database. Also the keycloak instance will deployed with default dataset matched to the application with all the realm, client and user data sets.
+
+Proceed the testings with `AUTHENTICATION` API request under BANKING_CORE_MICROSERVICES COLLECTION.
+
+```
+Test Credentials : [email protected] / 5V7huE3G86uB
+```
+
 ### Microservices Inside This Project
 
 Here this project consist of mainly 6 microservices and those are,
@@ -75,5 +128,3 @@ Article series
 
 <h1 align="center">Hi 👋, I'm Chinthaka Dinadasa</h1>
 <h3 align="center">A Passionate Java Fullstack Developer from Sri Lanka and Author of JavatoDev.com</h3>
-
-<p align="left"> <a href="https://twitter.com/spbootdeveloper" target="blank"><img src="https://img.shields.io/twitter/follow/spbootdeveloper?logo=twitter&style=for-the-badge" alt="spbootdeveloper" /></a> </p>

docker-compose/docker-compose.yml

@@ -4,6 +4,7 @@ services:
 
   zipkin:
     image: openzipkin/zipkin:3
+    container_name: openzipkin_server
     ports:
       - 9411:9411
     networks:
@@ -33,6 +34,7 @@ services:
 
   keycloakdb:
     image: postgres:15
+    container_name: keycloak_postgre_db
     volumes:
       - postgres_data:/var/lib/postgresql/data
     environment:
@@ -58,6 +60,7 @@ services:
 
   internet-banking-config-server:
     image: javatodev/internet-banking-config-server
+    container_name: internet-banking-config-server
     ports:
       - 8090:8090
     networks:
@@ -66,6 +69,7 @@ services:
 
   internet-banking-service-registry:
     image: javatodev/internet-banking-service-registry
+    container_name: internet-banking-service-registry
     ports:
       - 8081:8081
     networks:
@@ -74,6 +78,7 @@ services:
 
   internet-banking-api-gateway:
     image: javatodev/internet-banking-api-gateway
+    container_name: internet-banking-api-gateway
     ports:
       - 8082:8082
     entrypoint: ["./wait-for-it.sh", "internet-banking-service-registry:8081", "--timeout=50", "--", "./wait-for-it.sh", "internet-banking-config-server:8090", "--timeout=50", "--", "java", "-jar", "-Dspring.profiles.active=docker", "/app.jar"]
@@ -83,6 +88,7 @@ services:
 
   internet-banking-user-service:
     image: javatodev/internet-banking-user-service
+    container_name: internet-banking-user-service
     ports:
       - 8083:8083
     entrypoint: ["./wait-for-it.sh", "internet-banking-service-registry:8081", "--timeout=50", "--", "./wait-for-it.sh", "internet-banking-config-server:8090", "--timeout=50", "--", "./wait-for-it.sh", "mysql_core_db:3306", "--timeout=50", "--","java", "-jar", "-Dspring.profiles.active=docker", "/app.jar"]
@@ -92,6 +98,7 @@ services:
 
   internet-banking-fund-transfer-service:
     image: javatodev/internet-banking-fund-transfer-service
+    container_name: internet-banking-fund-transfer-service
     ports:
       - 8084:8084
     entrypoint: ["./wait-for-it.sh", "internet-banking-service-registry:8081", "--timeout=50", "--", "./wait-for-it.sh", "internet-banking-config-server:8090", "--timeout=50", "--", "./wait-for-it.sh", "mysql_core_db:3306", "--timeout=50", "--","java", "-jar", "-Dspring.profiles.active=docker", "/app.jar"]
@@ -100,6 +107,7 @@ services:
         ipv4_address: 172.25.0.4
 
   internet-banking-utility-payment-service:
+    container_name: internet-banking-utility-payment-service
     image: javatodev/internet-banking-utility-payment-service
     ports:
       - 8085:8085
@@ -110,6 +118,7 @@ services:
 
   core-banking-service:
     image: javatodev/core-banking-service
+    container_name: core-banking-service
     ports:
       - 8092:8092
     entrypoint: ["./wait-for-it.sh", "internet-banking-service-registry:8081", "--timeout=50", "--", "./wait-for-it.sh", "internet-banking-config-server:8090", "--timeout=50", "--", "./wait-for-it.sh", "mysql_core_db:3306", "--timeout=50", "--","java", "-jar", "-Dspring.profiles.active=docker", "/app.jar"]