Skip to content

Commit 5d2b906

Browse files
committed
Readme: Unify description
1 parent 81f7208 commit 5d2b906

File tree

4 files changed

+43
-31
lines changed

4 files changed

+43
-31
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# Java Microservices
2+
23
- [Dropwizard](dropwizard-app/README.md)
34
- [Spring](spring-app/README.md)
5+
- [Micronaut](micronaut-app/README.md)
46

57
## Quick start
6-
1. Build: `./gradlew clean build`
7-
2. Spin Up DB And Wiremock: `docker-compose -f docker-compose.yml up -d`
8-
3. Start one of the Apps:
9-
- `./run-dropwizard.sh`
10-
- `./run-spring.sh`
11-
- `./run-micronaut.sh`
12-
4. Run Gatling: `./gradlew :loadtest:gatlingRun`
8+
9+
1. Build
10+
- `./gradlew clean build`
11+
2. Spin Up Postgres & Wiremock:
12+
- `docker-compose up -d`
13+
3. Start one of the Apps:
14+
- `./run-dropwizard.sh`
15+
- `./run-spring.sh`
16+
- `./run-micronaut.sh`
17+
4. Run Gatling:
18+
- `./gradlew :loadtest:gatlingRun`

dropwizard-app/README.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1-
# Dropwizard application
1+
# Dropwizard
22

3-
How to start the Dropwizard application
4-
---
3+
## Build & Run
54

6-
1. Run `gradle clean build` to build your application
7-
2. Start application with `java -jar build/libs/dropwizard-app-1.0-SNAPSHOT-all.jar server classpath:config.yml`
8-
3. To check that your application is running enter url `curl http://localhost:8080/accounts`
5+
1. Build
6+
- `gradle clean build`
7+
2. Start application
8+
- `java -jar build/libs/dropwizard-app-1.0-SNAPSHOT-all.jar server classpath:config.yml`
9+
3. To check that your application is running
10+
- `curl http://localhost:8080/accounts`
11+
- `curl http://localhost:8081/healthcheck`
912

10-
Note: `classpath:config.yml` supported thanks to `ClasspathOrFileConfigurationSourceProvide`
11-
12-
13-
Health Check
14-
---
15-
16-
To see your application's health enter url `http://localhost:8081/healthcheck`
13+
Note: `classpath:config.yml` supported via customization `ClasspathOrFileConfigurationSourceProvide`

micronaut-app/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Micronaut
2+
3+
## Build & Run
4+
5+
1. Build
6+
- `gradle clean build`
7+
2. Start application
8+
- `java -jar build/libs/micronaut-app-1.0-SNAPSHOT-all.jar`
9+
3. To check that your application is running
10+
- `curl http://localhost:8080/accounts`
11+
- `curl http://localhost:8081/health`

spring-app/README.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
# Dropwizard
1+
# Spring
22

3-
How to start the Dropwizard application
4-
---
3+
## Build & Run
54

6-
1. Run `gradle clean build` to build your application
7-
1. Start application with `java -jar build/libs/spring-app-1.0-SNAPSHOT.jar`
8-
1. To check that your application is running enter url `curl http://localhost:8080/accounts`
9-
10-
Health Check
11-
---
12-
13-
To see your application's health enter url `http://localhost:8081/actuator/health`
5+
1. Build
6+
- `gradle clean build`
7+
2. Start application
8+
- `java -jar build/libs/spring-app-1.0-SNAPSHOT.jar`
9+
3. To check that your application is running
10+
- `curl http://localhost:8080/accounts`
11+
- `curl http://localhost:8081/actuator/health`

0 commit comments

Comments
 (0)