|
| 1 | +# mtls-client-cert-guard |
| 2 | + |
| 3 | +This project uses Quarkus, the Supersonic Subatomic Java Framework. |
| 4 | + |
| 5 | +If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>. |
| 6 | + |
| 7 | +## Running the application in dev mode |
| 8 | + |
| 9 | +You can run your application in dev mode that enables live coding using: |
| 10 | + |
| 11 | +```shell script |
| 12 | +./mvnw quarkus:dev |
| 13 | +``` |
| 14 | + |
| 15 | +> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at <http://localhost:8080/q/dev/>. |
| 16 | +
|
| 17 | +## Packaging and running the application |
| 18 | + |
| 19 | +The application can be packaged using: |
| 20 | + |
| 21 | +```shell script |
| 22 | +./mvnw package |
| 23 | +``` |
| 24 | + |
| 25 | +It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. |
| 26 | +Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory. |
| 27 | + |
| 28 | +The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`. |
| 29 | + |
| 30 | +If you want to build an _über-jar_, execute the following command: |
| 31 | + |
| 32 | +```shell script |
| 33 | +./mvnw package -Dquarkus.package.jar.type=uber-jar |
| 34 | +``` |
| 35 | + |
| 36 | +The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. |
| 37 | + |
| 38 | +## Creating a native executable |
| 39 | + |
| 40 | +You can create a native executable using: |
| 41 | + |
| 42 | +```shell script |
| 43 | +./mvnw package -Dnative |
| 44 | +``` |
| 45 | + |
| 46 | +Or, if you don't have GraalVM installed, you can run the native executable build in a container using: |
| 47 | + |
| 48 | +```shell script |
| 49 | +./mvnw package -Dnative -Dquarkus.native.container-build=true |
| 50 | +``` |
| 51 | + |
| 52 | +You can then execute your native executable with: `./target/mtls-client-cert-guard-1.0.0-SNAPSHOT-runner` |
| 53 | + |
| 54 | +If you want to learn more about building native executables, please consult <https://quarkus.io/guides/maven-tooling>. |
| 55 | + |
| 56 | +## Related Guides |
| 57 | + |
| 58 | +- JDBC Driver - PostgreSQL ([guide](https://quarkus.io/guides/datasource)): Connect to the PostgreSQL database via JDBC |
| 59 | +- SmallRye OpenAPI ([guide](https://quarkus.io/guides/openapi-swaggerui)): Document your REST APIs with OpenAPI - comes with Swagger UI |
| 60 | +- Hibernate ORM with Panache ([guide](https://quarkus.io/guides/hibernate-orm-panache)): Simplify your persistence code for Hibernate ORM via the active record or the repository pattern |
| 61 | +- REST Jackson ([guide](https://quarkus.io/guides/rest#json-serialisation)): Jackson serialization support for Quarkus REST. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it |
0 commit comments