spring-microservices-blueprint

(★ 144)

Java Spring Boot microservices stack (PostgreSQL, Kafka, Elasticsearch, Kibana, Fluentd, JWT Auth, Swagger) — easily build & run all services in two commands.

  • .gitignore
  • docker-compose.yml
  • Docker_guid.md
  • e2e.sh
  • mvnw
  • mvnw.cmd
  • pom.xml
  • README.md
  • spring microservices.postman_collection.json

# Installation Guide

1. Get the code
git clone https://github.com/cuongnh28/spring-microservices-blueprint

Downloads the entire project code from GitHub to your computer.

cd spring-microservices-blueprint

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker --version # Should show Docker 20.10+

Type this command into your terminal and run it.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose ps

Runs the command against the services defined in the compose file.

docker compose build

Runs the command against the services defined in the compose file.

docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
mvn -version # Should show Maven 3.9+

Installs dependencies and builds the project using Maven.

mvn clean install -DskipTests

Installs dependencies and builds the project using Maven.

docker compose down -v && mvn clean install -DskipTests && docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

mvn dependency:purge-local-repository

Installs dependencies and builds the project using Maven.

A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

// repository documentation