Skip to content

Commit 2e08a9b

Browse files
committed
Adding readme imgs
1 parent 44ed279 commit 2e08a9b

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,41 @@ Basic skeleton for Spring Boot Microservices. It includes spring security for ba
1010
```
1111
- Build the project
1212
```
13-
mvn clean package -DskipTests
14-
15-
![Maven Build](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/build.png?raw=true)
16-
17-
13+
mvn clean package -DskipTests
1814
```
15+
![Maven Build](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/build.png?raw=true)
16+
1917
- Locate the docker directory from the root directory and run docker compose to startup the containers
2018
```
2119
cd docker && docker-compose up --build
2220
```
21+
![Docker Compose Build](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/docker-compose.png?raw=true)
22+
23+
- Check if all our services are running and healthy
24+
```
25+
docker ps
26+
```
27+
![Docker PS](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/docker-ps.png?raw=true)
28+
2329
- Let's check if all the services are up and running. We will reach to eureka server using gateway.
2430
Open the browser and hit http://localhost:8443/eureka/web You will need to authenticate yourself before accessing the endpoint.
2531
```
2632
username : user
2733
password : password
2834
```
29-
- Now, we have a look at our gateway endpoints configurations as well. Hit http://localhost:8443/actuator/gateway/routes in the browser again and
30-
you should be able to find all the routes configured.
35+
![Eureka](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/eureka.png?raw=true)
36+
37+
- Now, we have a look at our gateway endpoints configurations as well. Hit http://localhost:8443/actuator/gateway/routes in the browser again and, you should be able to find all the routes configured.
38+
![Gateway Routes](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/gateway-routes.png?raw=true)
39+
3140

3241
- Coming to swagger/openapi specs, here is the address to access them - http://localhost:8443/openapi/swagger-ui.html
42+
![Swagger OpenApi Specs](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/swagger-openapi.png?raw=true)
3343

3444
- Please use the below curl to generate the access token with both read and write scope.
3545
```
3646
curl -k http://writer:secret-writer@localhost:8443/oauth2/token -d grant_type=client_credentials -d scope="course:read course:write"
3747
```
38-
48+
![Swagger OpenApi Specs](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/oauth-endpoint.png?raw=true)
49+
![Swagger OpenApi Specs](https://github.com/Nasruddin/spring-boot-based-microservices/blob/master/images/jwt-io.png?raw=true)
3950
## Note : Currently this project uses Spring Authorization server. Keep in mind, I'm planning to enhance the whole OAuth flow because it's in shaky state right now and, you may some face issues. We may also move to keycloak.

images/swagger-openapi.png

371 KB
Loading

0 commit comments

Comments
 (0)