Get Started

It’s a snap to be up and running with Quarkus.

Step 1

Install via Command Line Interface

Open your favorite CLI and paste this script to install the Quarkus CLI.

For Linux, macOS, and Windows (using WSL or bash compatible shell like Cygwin or MinGW)

              curl -Ls https://sh.jbang.dev | bash -s - app install --fresh --force quarkus@quarkusio
            

For Windows using Powershell

              iex "& { $(iwr https://ps.jbang.dev) } app install --fresh --force quarkus@quarkusio"
            

If it's your first time to install, you'll need ot restart your shell.

Or install via SDKMAN!

sdk install quarkus

Step 2

Create the Getting Started Application

Run this script in your CLI:

quarkus create && cd code-with-quarkus

Step 3

Run the Getting Started Application

Run this script in your CLI:

quarkus dev

Boom! Your Quarkus app is now running at `localhost:8080`

Step 4

Live Coding with Quarkus

Quarkus makes it easy to change your code on the fly. Let's modify the RESTful endpoint

Open src/main/java/GreetingsResource.java in a text editor or your favorite IDE and change "hello RESTEasy" to "hola RESTEasy". Then refresh the browser and see the changes.

              
@Path("/hello")
public class GreetingsResource {

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello RESTEasy";
    }
}

            

Cool stuff right? Learn more about Quarkus's dev mode.

Next Steps

Building Native Executables

Build native executables with GraalVM or Mandrel.

Continuous Testing

Learn how to use continuous testing in your Quarkus Application.

Start with Serverless

Create a portable Java API to write serverless functions deployable to AWS Lambda, Azure Functions, Knative, and more.

Quarkus Tools in Your Favorite IDE

Every developer has their favorite IDE. Learn how to use Quarkus in yours.

Writing JSON REST services

JSON is now the lingua franca between microservices. See how you can get your REST services to consume and produce JSON payloads.

Getting Started with Reactive

Learn more about developing reactive applications with Quarkus.

Deploying Quarkus Applications on Kubernetes

This guide covers how to deploy a native application on Kubernetes.