Procedure

1. On your web browser, go to This content is not included.https://code.quarkus.redhat.com.

2. From the list of available versions, the code.quarkus.redhat.com application selects the latest release of Red Hat build of Quarkus by default.

   Note

   code.quarkus.redhat.com uses the latest release of Red Hat build of Quarkus, which is the preferred option. However, after generating your project, you can manually change to an earlier BOM version in the pom.xml file if necessary, but the best practice is to keep the default.

3. 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 for the Maven artifacts generated by your project, such as 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 following setups:

      • The directory structure of your generated project
      • The format of configuration files that are 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

        Note

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

4. Specify additional details about your application project:

   1. To display the fields that contain further application details, select More options.

      
   2. Enter a version you want to use for artifacts generated by your project. The default value of this field is 1.0.0-SNAPSHOT. Using Content from semver.org is not included.semantic versioning is preferred; however, you can choose to specify a different versioning type.
   3. Select whether you want code.quarkus.redhat.com to add starter code to your project. When you add extensions that are marked with "STARTER-CODE" to your project, you can enable this option to automatically create example class and resource files for those extensions when you generate your project. However, this option does not affect your generated project if you do not add any extensions that provide example code.

5. Select the extensions that you want to use. The Quarkus application includes the extensions you select as dependencies. The Quarkus platform also ensures these extensions are compatible with future versions.

   Important

   Do not use the quarkus-rest and the quarkus-resteasy extensions in the same project. Both provide similar capabilities, but they differ significantly in implementation and behavior. Use quarkus-rest instead.

   The quark icon ( ) next to an extension indicates that the extension is part of the Red Hat build of Quarkus platform release. Red Hat prefers using extensions from the same platform because they are tested and verified together, making them easier to use and upgrade.

   For extensions marked with "STARTER-CODE", you can enable the option to generate starter code automatically.

   

6. To confirm your choices, select Generate your application. After generation, a dialog box displays the following items:

   • A link to download the archive that contains your generated project
   • A command that you can use to compile and start your application
7. To save the archive with the generated project files to your machine, select Download the ZIP.
8. Extract the contents of the archive.

Verification

1. Check the extracted structure and verify the pom.xml file is present in the root directory of your generated project.

2. Start the application in dev mode. Use either Apache Maven or the Maven wrapper:

   mvn quarkus:dev

   Copy code to clipboard

    

   or

   ./mvnw quarkus:dev

   Copy code to clipboard

    

   The following extract shows an example of the expected output:

   INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
   INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, rest, smallrye-context-propagation, vertx]

   Copy code to clipboard

Procedure

1. To generate the project, in a command terminal, enter the following command:

   quarkus create && cd code-with-quarkus

   Copy code to clipboard

    

   Note

   You can also specify the 'app' subcommand, for example, quarkus create app. However, it is not mandatory to do so because the 'app' subcommand is implied if it is not specified.

   With this command, you create the Quarkus project in a folder called code-with-quarkus in your current working directory.

2. By default, the groupId, artifactId, and version attributes are specified with the following default values:

   • groupId='org.acme'
   • artifactId='code-with-quarkus'

   • version='1.0.0-SNAPSHOT'

     To change the values of the groupId, artifactId, and version attributes, issue the quarkus create command and specify the following syntax on the CLI:

     groupId:artifactId:version

     For example, quarkus create app mygroupId:myartifactid:version

   Note

   To view information about all the available Quarkus commands, specify the help parameter:

   quarkus --help

   Copy code to clipboard

3. Review the src/main/java/org/acme/GreetingResource.java file in a text editor:

   package org.acme;
   
   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   @Path("/hello")
   public class GreetingResource {
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return "Hello from Quarkus REST";
       }
   }

   Copy code to clipboard

    

   This file contains a simple REST endpoint that returns Hello from Quarkus REST as a response to a request that you send to the /hello endpoint.