https://github.com/perusworld/spring-cloud-starter
Spring Cloud Starter
https://github.com/perusworld/spring-cloud-starter
backend-services gateway mongodb rabbitmq registry rest-api spring-boot spring-cloud startup webapp
Last synced: 5 months ago
JSON representation
Spring Cloud Starter
- Host: GitHub
- URL: https://github.com/perusworld/spring-cloud-starter
- Owner: perusworld
- License: mit
- Created: 2018-05-04T17:40:00.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-05T20:20:02.000Z (almost 2 years ago)
- Last Synced: 2024-08-05T23:39:35.783Z (almost 2 years ago)
- Topics: backend-services, gateway, mongodb, rabbitmq, registry, rest-api, spring-boot, spring-cloud, startup, webapp
- Language: Java
- Size: 246 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spring-cloud-starter
Spring Cloud Starter
## Development
### Startup Core Services Before Dev
```bash
mvn clean package -Dmaven.test.skip=true
cd docker
docker-compose -f core-services-docker-compose.yml build
docker-compose -f core-services-docker-compose.yml up -d
docker-compose -f service-routing-docker-compose.yml build
docker-compose -f service-routing-docker-compose.yml up -d
```
### Stop Core Services
```bash
cd docker
docker-compose -f service-routing-docker-compose.yml stop
docker-compose -f core-services-docker-compose.yml stop
```
### Test
```bash
mvn compile test
```
### Startup Backend Services During UI Dev
```bash
mvn package
cd docker
docker-compose -f services-docker-compose.yml build
docker-compose -f services-docker-compose.yml up -d
```
### Stop Backend Services During UI Dev
```bash
cd docker
docker-compose -f services-docker-compose.yml stop
```
### Startup Web
```bash
mvn package
cd docker
docker-compose -f web-docker-compose.yml build
docker-compose -f web-docker-compose.yml up -d
```
### Stop Web
```bash
cd docker
docker-compose -f web-docker-compose.yml stop
```
### Dev Instance URLs
| Service | URL | UID/PWD | Health | URL via Gateway |
| ------------- | ------------- | :-----: | --- | --- |
| Rabbit MQ | [http://localhost:15672/](http://localhost:15672/) | guest/guest | | |
| Postgres Admin | [http://localhost:5431](http://localhost:5431) | user@db.com/pwd | | |
| Mongo Admin | [http://localhost:27016](http://localhost:27016) | | | |
| Service Registry | [http://localhost:8761](http://localhost:8761) | | | |
| Service Gateway | [http://localhost:8080](http://localhost:8080) | | [http://localhost:9080/actuator/health](http://localhost:9080/actuator/health) | |
| Sample REST Service | [http://localhost:8081/](http://localhost:8081/) | | [http://localhost:9081/actuator/health](http://localhost:9081/actuator/health) | [http://localhost:8080/sample-rest-service/](http://localhost:8080/sample-rest-service/) |
| Sample AMQP Service | | | [http://localhost:9083/actuator/health](http://localhost:9083/actuator/health) | |
| Sample Spring Web | [http://localhost:8082/](http://localhost:8082/) | | [http://localhost:9082/actuator/health](http://localhost:9082/actuator/health) | [http://localhost:8080/sample-spring-web/](http://localhost:8080/sample-spring-web/) |
## Documentation
[html version](documentation/sample-rest-service/index.html), [pdf version](documentation/sample-rest-service/index.pdf), [postman collection](documentation/sample-rest-service/postman-collection.json), [insomnia collection](documentation/sample-rest-service/insomnia-collection.json), [swagger](documentation/sample-rest-service/swagger.json)
### Generate Documentation
Requires [wkhtmltopdf](https://wkhtmltopdf.org/index.html), [jq](https://stedolan.github.io/jq/), [restdocs-to-postman](https://github.com/fbenz/restdocs-to-postman), [swaggymnia](https://github.com/mlabouardy/swaggymnia)
```bash
mvn clean package
cd documentation/sample-rest-service
cp ../../sample-rest-service/target/generated-docs/index.html .
wkhtmltopdf index.html index.pdf
cd ../../sample-rest-service/target
restdocs-to-postman --input generated-snippets --export-format postman --determine-folder secondLastFolder --replacements ../../documentation/config/replacements.json --output ../../documentation/sample-rest-service/postman-collection.json
restdocs-to-postman --input generated-snippets --export-format insomnia --determine-folder secondLastFolder --replacements ../../documentation/config/replacements.json --output ../../documentation/sample-rest-service/insomnia-collection.json
cd ../../documentation/sample-rest-service
jq '.info.name="Sample REST Service - Postman"' postman-collection.json > postman-collection.tmp
jq '.item[0].name="Sample Requests"' postman-collection.tmp > postman-collection.json
rm postman-collection.tmp
jq '.resources[0].name="Sample REST Service - Insomnia Sample Requests"' insomnia-collection.json > insomnia-collection.tmp
mv insomnia-collection.tmp insomnia-collection.json
swaggymnia generate -insomnia insomnia-collection.json -config ../config/swaggymnia.json -output json
cd ../../
```