Skip to content

ochmanskide/quarkus.code-with-quarkus

Repository files navigation

code-with-quarkus

This project uses Quarkus, the Supersonic Subatomic Java Framework.

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

1. Getting started

1.1 Prerequisites

It is assumed that you have basic software tools such as git, java, gradle. Ideally you would have SDKMAN installed and all the tools would download themselves, based on instructions provided inside of .sdkmanrc file.
If you don't have SDKMAN, it is not the end of the world. You should be able to start the project with your tools as well.

1.2. Download project

Clone source code into destination of your choice:

git clone git@github.com:ochmanskide/quarkus.code-with-quarkus.git ~/Workspace/github/ochmanskide/quarkus/code-with-quarkus

2. Running the application in dev mode

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

gradle quarkusDev

if you have quarkus installed you may simply run:

quarkus dev

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

3. Packaging and running the application

The application can be packaged using:

gradle build -x test

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

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

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

gradle build -x test -Dquarkus.package.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar ./build/code-with-quarkus-*-runner.jar.

4. Creating a native executable

You can create a native executable using:

gradle build -x test -Dquarkus.package.type=native

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

gradle build -x test -Dquarkus.package.type=native -Dquarkus.native.container-build=true

You can then execute your native executable with: ./build/libs/code-with-quarkus-1.0.0-SNAPSHOT-runner

5. Related Guides

  • RESTEasy Classic (guide): REST endpoint framework implementing JAX-RS and more

6. Provided Code

6.1. RESTEasy JAX-RS

Easily start your RESTful Web Services

Related guide section...

12. License

Copyright 2023 Lukasz Ochmanski

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.