README.md

Java Blocking Microservice Chassis

Table of contents

• Getting started

  • Requirements
  • Usage

• Dependencies

  • Web Framework
  • Development Tools
  • Persistence
  • Data Migration
  • Monitoring
  • API Documentation
  • Testing
  • Containerization

• Contributing

• License

Getting Started

Requirements

Software

• JDK 16
• intellij IDE
• Maven
• Spring Initializer to generate project and its dependencies
• Docker Engine

Usage

Run the restful application server:

$ docker compose up --build -d

Stop the restful application server:

$ docker compose stop chassis

Stop and remove containers and networks:

$ docker compose down

Dependencies

Web Framework

• Spring Web

Development Tools

• Lombok
• Spring Boot Dev Tools
• H2 database

Persistence

• Spring Data JPA

Data Migration

• Liquibase

Monitoring

• Spring Boot Actuator
• Spring Cloud Sleuth

API Documentation

• SpringDoc OpenAPI
• Spring Rest Doc

Testing

• Spring Boot Test
• TestContainers
• WireMock Test

Containerization

• Layered Jar

Contributing

• GitHub Issues

License

• License