Quarkus

Create a new Quarkus project

1. Launch IntelliJ IDEA.

   If the Welcome screen opens, click New Project.

   Otherwise, go to File | New | Project in the main menu.

2. Select Quarkus from the left pane.

   • Click to enter the URL of the service that you want to use, or leave the default one.

   • Specify a name and location for your project and configure project metadata: select a language, a build tool, and specify an artifact ID.

   • From the JDK list, select the JDK that you want to use in your project.

     If the JDK is installed on your computer, but not defined in the IDE, select Add JDK and specify the path to the JDK home directory.

     If you don't have the necessary JDK on your computer, select Download JDK.

   • Select the Add sample code option to create a REST endpoint named ExampleResource together with the project.

   

   Click Next.

3. On the next step of the wizard, from the Extensions list, select the necessary options and click Create.

Run the Quarkus application

IntelliJ IDEA creates a Quarkus run configuration that executes the necessary Maven goal or Gradle task.

• Select the Quarkus run configuration in the main toolbar and click or press Shift+F10.

  Alternatively, you can press Alt+Shift+F10 and select the necessary run configuration.

  If successful, you should see the output log in the Run tool window.

  

By default, the application starts on http://localhost:8080. Open this address in a web browser to see the Quarkus landing page:

If you open the http://localhost:8080/hello endpoint, you will see the string Hello from RESTEasy Reactive.

Open Quarkus Dev UI

You can open the Quarkus Dev UI right in the IDE.

1. Run a Quarkus application.

2. In the Run tool window, click (Open Quarkus Dev UI).

This will open the Quarkus Dev UI in a new editor tab.

Add extensions to existing Quarkus projects

Quarkus extensions are pre-configured sets of your project dependencies.

When you create a new Quarkus project with IntelliJ IDEA, you can add extensions in the dedicated new project wizard. You can also add them to existing projects using Add Extensions inlay hints in your build files.

1. Open your pom.xml or build.gradle(.kts) file.

2. In the dependencies block, click Add Extensions.

   

3. In the Add Extensions dialog that opens, add or remove extensions.

   

Your build file will be modified accordingly. When you add dependencies this way, IntelliJ IDEA considers your Quarkus version, saving you from the need to worry about compatible dependency versions.

You can disable and enable this inlay hint in the IDE settings (Ctrl+Alt+S), in Editor | Inlay Hints | Other, under Groovy, Kotlin, and XML.

Quickly create a connection to a database

Using the Database Tools and SQL plugin, IntelliJ IDEA lets you create and manage connections to databases.

In a Quarkus project, you can instantly create it from your application properties file.

1. Open an application.properties or application.yml file. If it contains datasource-related properties , the datasource icon will be displayed in the gutter.

2. Click . This will open the data source creation form with datasource parameters (such as URL, username, or database name) populated based on data from your configuration file.

   If the data source is already configured, the datasource icon is displayed instead. Click it to open the datasource in the Database tool window.

   

Below is the list of databases for which this action is available:

• Amazon Redshift

• Apache Cassandra

• Apache Derby

• Couchbase

• H2

• HSQLDB

• IBM Db2

• MariaDB

• Microsoft SQL Server

• MongoDB

• MySQL

• Oracle Database

• PostgreSQL

• Redis

• SQLite

• Sybase

For more details on data source parameters, refer to Data sources.

Debug the Quarkus application

To debug a running Quarkus application, attach the debugger to it.

1. Set a breakpoint in your code.

   For example, you can set it on the line with the return statement in the hello() method.

2. In the main menu, go to Run | Attach to Process.

3. From the list of Java processes, select the process of your Quarkus application.

   If successful, IntelliJ IDEA will open the Debug tool window with the established debugger connection.

4. Now open http://localhost:8080/hello to call the hello() method. The debugger should stop at the breakpoint just before returning the greeting string.

5. In the Debug tool window, click F9 to continue the execution and return the string to the web browser.

To detach the debugger, click Ctrl+F2. This does not stop the actual application process, only detaches the debugger from it.