Browse documentation

Installation

Prepare Java 21, Git, curl, unzip and Docker for the local app quickstart, or add published QQQ modules to your own application.

> These instructions are for stable QQQ 4.0. For the prerelease without Docker, use the QQQ 4.1 RC1 quickstart.

Local app quickstart

For the editable app quickstart, use macOS, Linux or Windows WSL with a Java 21 JDK, Git, curl, unzip, Bash and a running Docker daemon. Run these commands in Bash, not native PowerShell. The launcher provides Maven Wrapper and a prebuilt Next dashboard; you do not need a Maven or Node.js installation, manual database setup, or an account. Keep ports 3000 and 8000 free.

Bash
java -version
javac -version
git --version
curl --version
unzip -v
docker info

Existing applications and framework contributors

Use Java 21 and Maven 3.8 or later for the manual Maven workflows below. Framework integration tests use Docker; sample browser acceptance also needs Chrome or Chrome for Testing. Node.js and qctl are not prerequisites for a Java QQQ application.

Maven dependencies

Import the published QQQ BOM under dependencyManagement, then declare the modules your application uses. The final version is 4.0.0. Review the release and migration guidance before adoption.

XML
<dependencyManagement>
   <dependencies>
      <dependency>
         <groupId>com.kingsrook.qqq</groupId>
         <artifactId>qqq-bom-pom</artifactId>
         <version>4.0.0</version>
         <type>pom</type>
         <scope>import</scope>
      </dependency>
   </dependencies>
</dependencyManagement>
<dependencies>
   <dependency>
      <groupId>com.kingsrook.qqq</groupId>
      <artifactId>qqq-backend-core</artifactId>
   </dependency>
</dependencies>

The Maven artifact is qqq-bom-pom; qqq-bom is the source directory name. Maven Central supplies these artifacts without GitHub Packages credentials. Importing the BOM manages versions; it does not add modules to your application.

The optional qctl CLI is distributed separately and does not determine your QQQ dependency version. Continue with the Quickstart.

Powered by qqq