Chapter 2. Creating the configuration quickstart project

The config-quickstart project lets you get up and running with a simple Quarkus application using Apache Maven and the Quarkus Maven plug-in. The following procedure demonstrates how you can create a Quarkus Maven project.

Procedure

  1. Verify that Maven is using JDK 11 and that the Maven version is 3.8.1 or higher:

    mvn --version

    If this command does not return JDK 11, ensure that the directory where JDK 11 is installed on your system is included in the PATH environment variable:

    export PATH=$PATH:/path/to/jdk-11
  2. Enter the following command to generate the project:

    mvn io.quarkus:quarkus-maven-plugin:1.11.7.Final-redhat-00009:create \
        -DprojectGroupId=org.acme \
        -DprojectArtifactId=config-quickstart \
        -DplatformGroupId=com.redhat.quarkus \
        -DplatformVersion=1.11.7.Final-redhat-00009 \
        -DclassName="org.acme.config.GreetingResource" \
        -Dpath="/greeting"
    cd config-quickstart

    This command creates the following items in the config-quickstart directory:

    • The Maven project directory structure
    • An org.acme.config.GreetingResource resource
    • A landing page that you can access at http://localhost:8080 after you start the application
    • Associated unit tests for testing your application in native mode and JVM mode
    • Example Dockerfile.jvm, Dockerfile.native and Dockerfile.fast-jar files in src/main/docker
    • The application configuration file

      Note

      Alternatively, you can download a Quarkus Maven project to use in this tutorial from the Quarkus quickstart archive or clone the Quarkus Quickstarts Git repository. The exercise is located in the config-quickstart directory.