Skip to content

Commit 15b31b9

Browse files
committed
refactor: Update README and index.html for improved clarity and organization
1 parent 3e98f88 commit 15b31b9

File tree

2 files changed

+130
-406
lines changed

2 files changed

+130
-406
lines changed

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🏗️ Complete Microservices Architecture with Advanced Patterns
1+
# Complete Microservices Architecture with Advanced Patterns
22

33
[![Java](https://img.shields.io/badge/Java-17-orange)](https://www.oracle.com/java/)
44
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.2.5-brightgreen)](https://spring.io/projects/spring-boot)
@@ -9,11 +9,11 @@
99

1010
> A comprehensive, production-ready microservices implementation featuring **Circuit Breaker Pattern**, **Saga Pattern**, and **Blue-Green Deployment** with Kubernetes orchestration.
1111
12-
## 🎯 Project Overview
12+
## Project Overview
1313

1414
This project demonstrates enterprise-grade microservices architecture patterns through a complete e-commerce platform implementation. It showcases advanced distributed systems patterns essential for building resilient, scalable applications.
1515

16-
### 🏆 Key Features
16+
### Key Features
1717

1818
-**6 Production-Ready Microservices**
1919
-**Circuit Breaker Pattern** with Resilience4j
@@ -24,21 +24,24 @@ This project demonstrates enterprise-grade microservices architecture patterns t
2424
-**Interactive Learning Platform**
2525
-**Zero-Downtime Deployments**
2626

27-
## 🏗️ Advanced Patterns Implemented
27+
## Advanced Patterns Implemented
28+
29+
### Circuit Breaker Pattern
2830

29-
### 🛡️ Circuit Breaker Pattern
3031
- **Technology**: Resilience4j
3132
- **Implementation**: All inter-service communications
3233
- **Features**: Configurable thresholds, automatic recovery, fallback strategies
3334
- **Monitoring**: Prometheus metrics integration
3435

35-
### 🔄 Saga Pattern (Orchestration)
36+
### Saga Pattern (Orchestration)
37+
3638
- **Coordinator**: OrderSagaOrchestrator
3739
- **State Storage**: MongoDB
3840
- **Event Bus**: Apache Kafka
3941
- **Features**: Automatic compensation, timeout handling, retry mechanisms
4042

41-
### 🔵🟢 Blue-Green Deployment
43+
### Blue-Green Deployment
44+
4245
- **Platform**: Kubernetes with Helm
4346
- **Features**: Zero-downtime deployment, instant rollback, canary support
4447
- **Automation**: Custom deployment scripts with health checks
@@ -50,35 +53,36 @@ This repository contains a collection of fully completed microservices built wit
5053
## Microservices Description
5154

5255
1. **Config Server**
56+
5357
- Provides centralized configuration for all microservices.
5458
- Uses Spring Cloud Config Server.
55-
5659
2. **Customer Service**
60+
5761
- Manages customer data and operations.
5862
- Integrated with Eureka Discovery.
59-
6063
3. **Discovery Service**
64+
6165
- Service registry using Netflix Eureka.
6266
- Enables service discovery for other microservices.
63-
6467
4. **Gateway Service**
68+
6569
- API Gateway for routing requests to appropriate microservices.
6670
- Uses Spring Cloud Gateway.
6771
- Includes distributed tracing and circuit breaker.
68-
6972
5. **Notification Service**
73+
7074
- Handles notifications and alerts.
7175
- Uses Kafka for messaging.
72-
7376
6. **Order Service**
77+
7478
- Manages orders and their statuses.
7579
- Integrated with Eureka Discovery.
76-
7780
7. **Payment Service**
81+
7882
- Processes payments.
7983
- Uses Eureka Discovery and Zipkin for tracing.
80-
8184
8. **Product Service**
85+
8286
- Manages product information.
8387
- Integrated with Eureka Discovery.
8488

@@ -100,23 +104,23 @@ This repository contains a collection of fully completed microservices built wit
100104
## Running the Microservices
101105

102106
1. **Clone the repository**
107+
103108
```sh
104109
git clone https://github.com/PramithaMJ/fully-completed-microservices.git
105110
cd fully-completed-microservices
106111
```
107-
108112
2. **Start Config Server**
113+
109114
```sh
110115
cd config-server
111116
mvn spring-boot:run
112117
```
113-
114118
3. **Start Discovery Service**
119+
115120
```sh
116121
cd discovery
117122
mvn spring-boot:run
118123
```
119-
120124
4. **Start Other Microservices**
121125
Start the remaining microservices in any order. Ensure they are configured to register with the Discovery Service.
122126

@@ -162,10 +166,11 @@ https://pramithamj.live
162166
<!--
163167
buy me a coffee
164168
-->
169+
165170
## Donation
166171

167172
***If you like what I do, maybe consider buying me a coffee***
168173

169174
<a href="https://buymeacoffee.com/lpramithamm"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" style="height: 35px !important; width: 120px !important;"></a>
170175

171-
***
176+
---

0 commit comments

Comments
 (0)