Quarkus boilerplate

Presentation

This boilerplate is a starting point for creating a Quarkus application with the following features :

• REST API
• NATS API
• Temporal API (if needed)
• Connection to PostgreSQL (if needed)
• Swagger UI

Prerequisites

1. Install Docker
2. Install the latest version of edifice-cli
3. Install Java 25 Maven and Quarkus CLI

Installation

Execute the following command and answer the questions based on your needs :

edifice project new quarkus <serviceName>

It will create a base project based on Quarkus in the directory serviceName in your current directory.

Build

./build.sh init clean install

Publish

./build.sh publish

Generate an image

./build.sh image

Usage in another service

In another Quarkus project

<dependency>
    <groupId>io.edifice</groupId>
    <artifactId>xxx-api</artifactId>
    <version>${xxx.version}</version>
</dependency>

In another NestJS project

If you want to work with a released version, just add the dependency to your project :

pnpm install xxx-nest-client --save

If you are working on the Quarkus service and on the NestJS project at the same time then just link the package :

cd this-project
./build.sh link-ts
cd ../nestjs-app
./build.sh link-client

Run

./build.sh run

This will start the application in dev mode, which means that it will be reloaded automatically when you change the code.