In a command terminal, enter the following command to verify that Maven is using JDK 11 or 17, and that the Maven version is 3.8.1 or higher:

mvn --version

If the preceding command does not return JDK 11 or 17, add the path to JDK 11 to the PATH environment variable and enter the preceding command again.

To use the Quarkus Maven plug-in to create a new project, use one of the following methods:

• Enter the following command:

  mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.2.5.Final-redhat-00007:create \
      -DprojectGroupId=<project_group_id> \
      -DprojectArtifactId=<project_artifact_id> \
      -DplatformGroupId=com.redhat.quarkus.platform \
      -DplatformArtifactId=quarkus-bom \
      -DplatformVersion=2.2.5.Final-redhat-00007

  In this command, replace the following values:

  • <project_group_id>: A unique identifier of your project

  • <project_artifact_id>: The name of your project and your project directory

• Create the project in interactive mode:

  mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.2.5.Final-redhat-00007:create

  When prompted, enter the required attribute values.

  Alternatively, you can create your project using the default values for the project attributes by entering the following command:

  mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.2.5.Final-redhat-00007:create -B

  The following table lists the attributes that you can define with the create command:

  Attribute	Default Value	Description
  projectGroupId	org.acme	A unique identifier of your project.
  projectArtifactId	none	The name of your project and your project directory. If you do not specify the projectArtifactId, the Maven plug-in starts the interactive mode. If the directory already exists, the generation fails.
  projectVersion	1.0-SNAPSHOT	The version of your project.
  platformGroupId	com.redhat.quarkus.platform	The group id of your platform. All the existing platforms are provided by io.quarkus. However, you can change the default value.
  platformArtifactId	quarkus-bom	The artifact id of your platform BOM. To use the locally built Quarkus add quarkus-bom to your pom.xml file.
  platformVersion	The latest platform version	The version of the platform you want to use for your project. You can provide a version range and the Maven plug-in uses the latest version.
  className	${projectGroupId}/GreetingResource.java	The fully qualified name of the generated resource. After the application is created, the REST endpoint is exposed at the following URL: http://localhost:8080/$path If you use the default path, the URL is http://localhost:8080/hello.
  path	/hello	The resource path, only if you set the className.
  extensions	[]	The list of extensions you want to add to your project, separated by a comma.

Open the pom.xml file in a text editor.

Add the configuration properties that contain:

<properties>
    <quarkus.platform.version>2.2.3.Final-redhat-00013</quarkus.platform.version>
    <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
    <quarkus.platform.group-id>com.redhat.quarkus.platform</quarkus.platform.group-id>
    <surefire-plugin.version>3.0.0-M5</surefire-plugin.version>
</properties>

Add the Quarkus GAV (group, artifact, version) and use the quarkus-bom file to omit the versions of the different Quarkus dependencies:

<dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>${quarkus.platform.group-id}</groupId>
        <artifactId>${quarkus.platform.artifact-id}</artifactId>
        <version>${quarkus.platform.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

Add the Quarkus Maven plug-in:

<build>
    <plugins>
        <plugin>
            <groupId>${quarkus.platform.group-id}</groupId>
            <artifactId>quarkus-maven-plugin</artifactId>
            <version>${quarkus.platform.version}</version>
            <executions>
                <execution>
                    <goals>
                        <goal>build</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>${surefire-plugin.version}</version>
            <configuration>
                <systemPropertyVariables>
                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                    <maven.home>${maven.home}</maven.home>
                </systemPropertyVariables>
            </configuration>
        </plugin>
    </plugins>
</build>

Optional: To build a native application, add a specific native profile that includes the Maven Failsafe plug-in:

<profiles>
    <profile>
        <id>native</id>
        <properties>
            <quarkus.package.type>native</quarkus.package.type>
        </properties>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-failsafe-plugin</artifactId>
                    <version>${surefire-plugin.version}</version>
                    <executions>
                        <execution>
                            <goals>
                                <goal>integration-test</goal>
                                <goal>verify</goal>
                            </goals>
                            <configuration>
                                <systemProperties>
                                    <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                                </systemProperties>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </profile>
</profiles>

• Tests that include IT in their names and contain the @NativeImageTest annotation are run against the native executable.

• For the complete explanation about native applications and their difference from JVM applications, see the Difference between JVM and native mode chapter.

Navigate to https://code.quarkus.redhat.com using a web browser.

Specify basic details about your project:

1. Enter a group name for your project. The name format follows the Java package naming convention, for example, org.acme.

2. Enter a name that you want to use for Maven artifacts generated from your project, for example, code-with-quarkus.

3. Select the build tool you want to use to compile and start your application. The build tool that you choose determines:

   • the directory structure of your generated project

   • the format of configuration files used in your generated project

   • the custom build script and command for compiling and starting your application that code.quarkus.redhat.com displays for you after you generate your project

     Red Hat provides support for using code.quarkus.redhat.com to create Quarkus Maven projects only.

     

Specify additional details about your application project:

1. Select Configure more options to display the fields that contain further application details.

2. Enter a version that is used in artifacts generated from your project. The default value of this field is 1.0.0-SNAPSHOT. Using semantic versioning is recommended, but you can use a different type of versioning if you prefer.

3. Select whether you want code.quarkus.redhat.com to add starter code to your project. When you add extensions that are marked with CODE to your project from the list of extensions, you can enable this option to automatically create example class files and resource files for those extensions when you generate your project. This option does not affect your generated project when you do not add any extensions that provide an example code.

   

   code.quarkus.redhat.com automatically uses the latest release of Red Hat build of Quarkus. You can manually change the BOM version in the pom.xml file after you generate your project.

Select the extensions you want to use in your application from the list of extensions. The selected extensions are included as dependencies of your Quarkus application, with their versions being managed by the Quarkus platform for ensuring their compatibility. Ensure that you do not use the RESTEasy and RESTEasy Reactive extensions in the same project.

The quark icon () next to an extension indicates that the extension is part of the Red Hat build of Quarkus platform release. Red Hat recommends that you use extensions from the same platform, because they are tested and verfied together, and thus are easier to use and upgrade.

You can enable the option to automatically generate starter code for extensions that are marked with CODE.

Select Generate your application to confirm your choices and display the overlay screen with the download link for the archive that contains your generated project. The overlay screen also shows the custom command that you can use to compile and start your application.

Select Download the ZIP to save the archive with the generated project files to your machine.

Extract the contents of the archive.

Navigate to the directory that contains your extracted project files:

cd <directory_name>

Compile and start your application in development mode:

./mvnw quarkus:dev

Navigate to your Quarkus project directory.

To list the available extensions, enter the following command:

./mvnw quarkus:list-extensions

To add an extension to your project, enter the following command where <extension> is the group, artifact, version (GAV) of the extension that you want to add:

./mvnw quarkus:add-extension -Dextensions="<extension>"

For example, to add the Agroal extension, enter the following command:

./mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-agroal"

To search for a specific extension, enter the extension name or partial name after -Dextensions=. The following example searches for extensions that contain the text jdbc, agroal, and non-exist-ent in the name:

./mvnw quarkus:add-extension -Dextensions=jdbc,agroal,non-exist-ent

This command returns the following result:

❌ Multiple extensions matching 'jdbc'
    * io.quarkus:quarkus-jdbc-h2
    * io.quarkus:quarkus-jdbc-mariadb
    * io.quarkus:quarkus-jdbc-postgresql
    Be more specific e.g using the exact name or the full gav.
✅ Adding extension io.quarkus:quarkus-agroal
❌ Cannot find a dependency matching 'non-exist-ent', maybe a typo?
[...]

To install all extensions that a specific text string returns, enter the extension name or partial name after -Dextensions=. The following example searches for and installs all extensions that begin with hibernate-:

./mvnw quarkus:add-extension -Dextensions="hibernate-*"

In CodeReady Studio or Eclipse, click File → Import.

Select Maven → Existing Maven Project.

On the next screen, select the root location of the project. A list of the found modules appears.

Select the generated project and click Finish.

To start your application, enter the following command in a new terminal window:

./mvnw quarkus:dev

In IntelliJ, complete one of the following tasks:

• Select File → New → Project From Existing Sources.

• On the Welcome page, select Import project.

Select the project root directory.

Select Import project from external model and then select Maven.

Review the options and then click Next.

Click Finish.

To start your application, enter the following command in a new terminal window:

./mvnw quarkus:dev

Select File → Open Project.

Select the project root directory.

Click Open Project.

To start your application, enter the following command in a new terminal window:

./mvnw quarkus:dev

Install the Java Extension Pack.

In Visual Studio Code, open your project directory. The project loads as a Maven project.

Open the application.properties file in a text editor.

Edit the values of properties that you want to change and save the file.

The following table list the properties that you can change:

Add the plug-in configuration to the pom.xml file:

<project>
    [...]
      <plugin>
          <groupId>io.quarkus</groupId>
          <artifactId>quarkus-bootstrap-maven-plugin</artifactId>
          <version>${quarkus.platform.version}</version>
      </plugin>
    [...]
</project>

To list the build dependency tree of your application, enter the following command:

./mvnw quarkus:dependency-tree

The output of this command should be similar to the following example:

[INFO] --- quarkus-bootstrap-maven-plugin:2.2:build-tree (default-cli) @ getting-started ---
[INFO] org.acme:getting-started:jar:1.0-SNAPSHOT
[INFO] └─ io.quarkus:quarkus-resteasy-deployment:jar:2.2 (compile)
[INFO]    ├─ io.quarkus:quarkus-resteasy-server-common-deployment:jar:2.2 (compile)
[INFO]    │  ├─ io.quarkus:quarkus-core-deployment:jar:2.2 (compile)
[INFO]    │  │  ├─ commons-beanutils:commons-beanutils:jar:1.9.3 (compile)
[INFO]    │  │  │  ├─ commons-logging:commons-logging:jar:1.2 (compile)
[INFO]    │  │  │  └─ commons-collections:commons-collections:jar:3.2.2 (compile)
...

Open the pom.xml file and verify that the native profile contains the following elements:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-failsafe-plugin</artifactId>
    <version>${surefire-plugin.version}</version>
    <executions>
        <execution>
            <goals>
                <goal>integration-test</goal>
                <goal>verify</goal>
            </goals>
            <configuration>
                <systemPropertyVariables>
                    <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                    <maven.home>${maven.home}</maven.home>
                </systemPropertyVariables>
            </configuration>
        </execution>
    </executions>
</plugin>

The failsafe-maven-plugin runs integration test and indicates the location of the produced native executable.

Open the src/test/java/org/acme/quickstart/NativeGreetingResourceIT.java file and verify that it includes the following content:

package org.acme.quickstart;


import io.quarkus.test.junit.NativeImageTest;

@NativeImageTest 1
public class NativeGreetingResourceIT extends GreetingResourceTest { 2

    // Run the same tests

}

Run the test:

./mvnw verify -Pnative

The following example shows the output of this command:

./mvnw verify -Pnative
...
[getting-started-1.0-SNAPSHOT-runner:18820]     universe:     587.26 ms
[getting-started-1.0-SNAPSHOT-runner:18820]      (parse):   2,247.59 ms
[getting-started-1.0-SNAPSHOT-runner:18820]     (inline):   1,985.70 ms
[getting-started-1.0-SNAPSHOT-runner:18820]    (compile):  14,922.77 ms
[getting-started-1.0-SNAPSHOT-runner:18820]      compile:  20,361.28 ms
[getting-started-1.0-SNAPSHOT-runner:18820]        image:   2,228.30 ms
[getting-started-1.0-SNAPSHOT-runner:18820]        write:     364.35 ms
[getting-started-1.0-SNAPSHOT-runner:18820]      [total]:  52,777.76 ms
[INFO]
[INFO] --- maven-failsafe-plugin:2.22.1:integration-test (default) @ getting-started ---
[INFO]
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running org.acme.quickstart.NativeGreetingResourceIT
Executing [/data/home/gsmet/git/quarkus-quickstarts/getting-started/target/getting-started-1.0-SNAPSHOT-runner, -Dquarkus.http.port=8081, -Dtest.url=http://localhost:8081, -Dquarkus.log.file.path=build/quarkus.log]
2019-04-15 11:33:20,348 INFO  [io.quarkus] (main) Quarkus 999-SNAPSHOT started in 0.002s. Listening on: http://[::]:8081
2019-04-15 11:33:20,348 INFO  [io.quarkus] (main) Installed features: [cdi, resteasy]
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.387 s - in org.acme.quickstart.NativeGreetingResourceIT
...

./mvnw verify -Pnative -Dquarkus.test.native-image-wait-time=<duration>

To start Quarkus in development mode, enter the following command in the directory that contains your Quarkus application pom.xml file:

./mvnw quarkus:dev

Make changes to your application and save the files.

Refresh the browser to trigger a scan of the workspace.

If any changes are detected, the Java files are recompiled and the application is redeployed. Your request is then serviced by the redeployed application. If there are any issues with compilation or deployment, an error page appears.

In development mode, the debugger is activated and listens on port 5005.

Optional: To wait for the debugger to attach before running the application, include -Dsuspend:

./mvnw quarkus:dev -Dsuspend

Optional: To prevent the debugger from running, include -Ddebug=false:

./mvnw quarkus:dev -Ddebug=false

Change one of the following values of the debug system property where PORT is the port that the debugger is listening on:

• false: The JVM starts with debug mode disabled.

• true: The JVM starts in debug mode and is listening on port 5005.

• client: The JVM starts in client mode and tries to connect to localhost:5005.

• PORT: The JVM starts in debug mode and is listening on PORT.

Change the value of the suspend system property. This property is used when Quarkus starts in debug mode.

• y or true: The debug mode JVM launch suspends.

• n or false: The debug mode JVM starts without suspending.