Quickstart the Application

Table of Contents

• Quickstart the Application
  • Table of Contents
  • Running the Container Stack for Local Development
    • Prerequisites
    • Required External Dependency
    • Dependency Version
    • Running the Required Containers
  • Running the Compose Stack

Running the Container Stack for Local Development

Prerequisites

• JDK 25+ (for coding and debugging, but not necessary if running the service in containers)
• Docker Desktop

Required External Dependency

The project uses the external dependency spring-base-commons.

• For Windows, run this script

• For Linux, run this script

  • Run chmod +x ./create-data-classes.sh if you don't have permission to execute the shell file.

Check if your pom.xml contains these lines in the <dependencies> section:

<dependency>
  <groupId>com.vulinh</groupId>
  <artifactId>spring-base-commons</artifactId>
  <version>${spring-base-commons.version}</version>
</dependency>

Dependency Version

This project uses spring-base-commons as an external dependency (see above). If you want to change the version, check the following locations:

• pom.xml file - find the property spring-base-commons.version.

• Environment variable SPRING_BASE_COMMONS_VERSION in:

  • Dockerfile

  • create-data-classes.cmd (Windows)

  • create-data-classes.sh (Linux)

  • GitHub Actions workflows (the variable is ${{ env.SPRING_BASE_COMMONS_VERSION }})

Running the Required Containers

You can run this script (Windows only) or this script (Linux only), and it will start the required containers for local development: PostgreSQL and Keycloak.

Both scripts have already handled the external dependency for you. See the Required External Dependency section for more information.

Running the Compose Stack

You can run this script (Windows only), or this script (Linux only) and it will build the service image and start the containers for you.

Again, both scripts have already handled the external dependency for you.

If you want to make use of host OS to build the images (to speed up the build process), run this script (Windows only) or this script (Linux only) instead.