Skip to content

Commit ee3c7ff

Browse files
committed
Update in README.md file
1 parent b0b2bbb commit ee3c7ff

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,26 @@
5656
</p>
5757

5858
# Spring Dynamic Microservices
59-
60-
6159
This is a comprehensive **Java-based microservices system** built with Spring Boot 3.x and Spring Cloud. It demonstrates dynamic service registration, routing, and payment processing using a modular architecture. The project includes CI integration with GitHub Actions and code quality checks with SonarCloud and JaCoCo.
6260

63-
### Modules
61+
#### Architecture Overview
62+
- **eureka-server**: Acts as the service registry for all microservices.
63+
- **gateway-service**: A Spring Cloud Gateway-based API Gateway that routes requests dynamically to microservices.
64+
- **payment-service-paypal**: A microservice simulating PayPal payment logic, registered with Eureka.
65+
- **payment-service-stripe**: A microservice simulating Stripe payment logic, registered with Eureka.
66+
- **docker-compose.yml**: Boots up all services with required ports and network for full-stack integration.
67+
68+
All services are **auto-discovered via Eureka** and routed through **Spring Cloud Gateway** without hardcoded endpoints.
6469

70+
#### Modules
6571
- `common-api` – Shared domain objects, constants, and utilities.
6672
- `eureka-server` – Service discovery server powered by Netflix Eureka.
6773
- `gateway-service` – Spring Cloud Gateway for dynamic routing and API exposure.
6874
- `payment-service-paypal` – PayPal-specific payment microservice.
6975
- `payment-service-stripe` – Stripe-specific payment microservice.
7076

71-
### DevOps, CI/CD & Quality Tools
77+
#### DevOps, CI/CD & Quality Tools
7278
```
73-
7479
| Tool | Purpose |
7580
|---------------|--------------------------------|
7681
| GitHub Actions| CI/CD pipeline |
@@ -80,24 +85,29 @@ This is a comprehensive **Java-based microservices system** built with Spring Bo
8085
| SonarCloud | Code quality, static analysis |
8186
```
8287

83-
### Testing
84-
88+
#### Testing
8589
- Unit testing with JUnit 5
8690
- Controller testing using Spring’s `MockMvc`
8791
- Code coverage with JaCoCo (`target/site/jacoco/index.html`)
8892
- Test reports pushed to SonarCloud
8993

90-
### Run Locally with Docker Compose
94+
#### Run Locally with Docker Compose
9195

92-
##### Requirements:
96+
##### Tech Stack
9397
- Java 17
94-
- Maven 3.x
98+
- Spring Boot 3.2.5
99+
- Spring Cloud Gateway
100+
- Eureka Server (Netflix OSS)
101+
- RESTful APIs
102+
- Maven
95103
- Docker & Docker Compose
96104

97-
##### Steps:
105+
##### Running with Docker Compose
98106

99107
```bash
100-
mvn clean install
108+
git clone https://github.com/vijayagopalsb/spring-dynamic-microservices.git
109+
cd spring-dynamic-microservices
110+
mvn clean package -DskipTests
101111
docker-compose up --build
102112
```
103113

0 commit comments

Comments
 (0)