Skip to content

lhsradek/platypus-quarkus

Repository files navigation

Platypus Quarkus Project

mvn io.quarkus:quarkus-maven-plugin:2.12.0.Final:create -DprojectGroupId=local.intranet.quarkus -DprojectArtifactId=platypus-quarkus -DclassName="local.intranet.quarkus.HelloResource" -Dpath="/hello" -Dextensions=agroal,resteasy-reactive,resteasy-reactive-qute,resteasy-reactive-jackson,resteasy-reactive-jaxb,resteasy-reactive-jsonb,smallrye-jwt,smallrye-health,smallrye-openapi,swagger-ui,jdbc-mysql,jdbc-h2,hibernate-orm,hibernate-orm,hibernate-validator,micrometer-registry-prometheus,flyway,spring-data-jpa,vertx,vertx-http,redis-client,hibernate-envers,logging-logback,logging-gelf,opentelemetry,scheduler,undertow,csrf-reactive,cache

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

./mvnw package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.

Creating a native executable

You can create a native executable using:

./mvnw package -Pnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/platypus-quarkus-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.

Related Guides

  • Quarkus Extension for Spring Data JPA API (guide): Use Spring Data JPA annotations to create your data access layer
  • Hibernate ORM (guide): Define your persistent model with Hibernate ORM and JPA
  • Eclipse Vert.x (guide): Write reactive applications with the Vert.x API
  • Hibernate Envers (guide): Enable Hibernate Envers capabilities in your JPA applications
  • Scheduler - tasks (guide): Schedule jobs and tasks
  • Hibernate Validator (guide): Validate object properties (field, getter) and method parameters for your beans (REST, CDI, JPA)
  • SmallRye JWT (guide): Secure your applications with JSON Web Token
  • SmallRye OpenAPI (guide): Document your REST APIs with OpenAPI - comes with Swagger UI
  • RESTEasy Reactive (guide): A JAX-RS implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
  • JDBC Driver - H2 (guide): Connect to the H2 database via JDBC
  • Redis Client (guide): Connect to Redis in either imperative or reactive style
  • Logging GELF (guide): Log using the Graylog Extended Log Format and centralize your logs in ELK or EFK
  • Flyway (guide): Handle your database schema migrations
  • Agroal - Database connection pool (guide): Pool JDBC database connections (included in Hibernate ORM)
  • SmallRye Health (guide): Monitor service health
  • JDBC Driver - MySQL (guide): Connect to the MySQL database via JDBC
  • OpenTelemetry (guide): Use OpenTelemetry to trace services
  • Swagger UI (guide): Swagger UI
  • Micrometer Registry Prometheus (guide): Enable Prometheus support for Micrometer

Provided Code

Hibernate ORM

Create your first JPA entity

Related guide section...

RESTEasy Reactive

Easily start your Reactive RESTful Web Services

Related guide section...

RESTEasy Reactive Qute

Create your web page using Quarkus RESTEasy Reactive & Qute

Related guide section...

SmallRye Health

Monitor your application's health using SmallRye Health

Related guide section...