simple-java-api

Table of Contents

1. Requirements
2. Getting Started
3. Containerization
4. OpenAPI
5. Roadmap
6. Contributing

Requirements

• Java 21 Temurin
• Apache Maven 3.6.3 or higher
• PostgreSQL 9.6 or higher
• Docker 20.10.21 or higher
• Docker Compose 2.13.0 or higher

Getting Started

Clone the Repository

Clone the repository to your local machine:

git clone git@github.com:timtwiest/simple-java-api.git

Run the PostgreSQL Database

Start the PostgreSQL database using Docker Compose:

docker-compose up -d postgres-db

Build the Project

Build the project using Maven:

mvn clean install

Containerization

This application is designed to be containerized using Docker. This allows the Spring Boot application to run in a reproducible environment.

Creating a Docker Image

Create a Docker image of the application:

docker build -t simple-java-api .

Starting the Application

Use the provided docker-compose.yaml to start both the PostgreSQL instance and the application:

docker-compose up -d

OpenAPI

The application features an OpenAPI interface for easy interaction with the API. It provides a user-friendly way to view and test the endpoints.

You can access the OpenAPI-interface locally at http://localhost:9080/api/ui.

Roadmap

coming soon

Contributing

coming soon