Skip to content

Commit d841ebb

Browse files
committed
simplified readme after diagram added
1 parent 9fe08bb commit d841ebb

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

readme.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# Guideline how to read this document
2-
First read this documentation with full concentration and understand clearly how the application working. I tried to describe
3-
as simple as possible. No need to run the application or understand the code initially. **Read all the sections first**.
4-
I used Java, Spring Boot and Angular but you no need to know any specific language or technology to understand microservice
2+
Read this documentation with full concentration and understand clearly how the application working. I tried to describe
3+
as simple as possible. No need to run the application or understand the code initially. **Read the documentation and understand
4+
the workflow diagram first**. I have used Java, Spring Boot and Angular but you no need to know any specific language or technology to understand microservice
55
concept. Just read the documentation first.
6-
Once you have completed the documentation then you can run every application in your local system by configuring system prerequisites
7-
and don't forget to notice console log when run all application as well as use it for better understanding.
8-
Here is total 5 separate application (1 frontend + 4 backend) and every application have it's own readme for application level understanding.
6+
7+
Once you have completed the documentation then you can run every application in your local system by configuring system
8+
prerequisites and don't forget to notice terminal log when you run all application, it helps for better understanding.
9+
Here is total 5 separate application (1 frontend + 4 backend).
10+
- microservice-ui (frontend)
11+
- service-registry
12+
- api-gateway
13+
- product-service
14+
- offer-service
915

1016
# What is microservice?
1117
Microservice is a modern as well as a popular architecture of designing software application over the last few years.
@@ -19,7 +25,7 @@ A microservice application is consist of different services where every service
1925
above two are the key requirements of a microservice application.
2026

2127
In this microservice application here are two service **product-service** and **offer-service** both independently
22-
deployable and scalable. **They are also using a different database but this is not an issue about microservice architecture.
28+
deployable and scalable. **They are using two different database but this is not an issue about microservice architecture.
2329
They can use the same database.**
2430

2531
To expose these two service as microservice architecture I used two other service those are **service-registry** for
@@ -96,11 +102,6 @@ It will not respond any products because backend services are not started yet.
96102
![store home](readme-images/store-home.png)
97103

98104
UI application is ready, Now we need to run it's backend applications.
99-
- service-registry
100-
- api-gateway
101-
- product-service
102-
- offer-service
103-
104105
All the backend applications are developed by spring-boot.
105106

106107
## Run service-registry application
@@ -302,7 +303,10 @@ will be lost too.
302303
RabbitMQ keeping all the events in itself will wait for any product-service instance when a product-service instance
303304
relaunched then RabbitMQ will start to push it's events immediately to running product-service instance. You can test it
304305
by shutting down all product-service by typing ``ctrl + c`` in all product-service launching terminal.
305-
This functionality is called **Event Driven Development(EDD).**
306+
This functionality is called **Event Driven Development(EDD).** EDD is not a mandatory part of microservice application,
307+
It's a smart way to do service to service communication.
308+
309+
Congratulations you have completed the documentation still recheck the workflow diagram that will make you 100% clear now.
306310

307311
# Conclusion
308312
So far this is a complete microservice application. You can enhance the application by adding other service like

0 commit comments

Comments
 (0)