This project uses Quarkus, the Supersonic Subatomic Java Framework.
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
In application.properties change line 19 to
false (it was set to true, now it is false). Afterwards run: docker compose up -d. If the
container is ready, start the application with ./gradlew quarkusDev. The application should be available under
localhost:8084
- Java 25 (JDK; Gradle downloads it automatically if missing)
- Use the included Gradle 9.7 wrapper (
./gradlew) - A running Docker-compatible container runtime for integration tests
- Make sure to run the ExplorViz software stack before starting the service, as it provides the required database(s) and the Kafka broker
Run the unit tests with ./gradlew test and the integration tests with
./gradlew integrationTest. Integration tests start their own Kafka and MongoDB
containers through Testcontainers; no separately running ExplorViz stack is needed.
./gradlew check runs both test suites and the code-analysis checks.
The Quarkus 3.40.1.1 LTS BOM manages the Testcontainers and Docker client versions.
You can run your application in dev mode that enables live coding using:
./gradlew quarkusDevThis also enables the dev configuration profile, i.e. using the properties prefixed with %dev from
src/main/resources/application.properties.
The application can be packaged and tested using:
./gradlew buildIt produces the quarkus-run.jar file in the build/quarkus-app/ directory.
You can skip running the integration tests by adding -x integrationTest. To skip all tests and code analysis use the assemble task
instead of build.
The application is now runnable using java -jar build/quarkus-app/quarkus-run.jar.
Be aware that it’s not an über-jar as the dependencies are copied into the build/quarkus-app/lib/ directory.
If you want to build an über-jar, which includes the entire application in a single jar file, execute the following command:
./gradlew build -Dquarkus.package.jar.type=uber-jarThe application, packaged as an über-jar, is now runnable using
java -jar build/user-service-1.0-SNAPSHOT-runner.jar.
You can add -Dquarkus.profile=dev to enable the %dev properties.
You can create a native executable using:
./gradlew build -Dquarkus.native.enabled=true -Dquarkus.package.jar.enabled=falseOr, if you don't have GraalVM installed, you can run the native executable build in a container using:
./gradlew build -Dquarkus.native.enabled=true -Dquarkus.package.jar.enabled=false -Dquarkus.native.container-build=trueYou can then execute your native executable with: ./build/user-service-1.0-SNAPSHOT-runner
If you want to learn more about building native executables, please consult https://quarkus.io/guides/gradle-tooling#building-a-native-executable.