Quick Start

This guide brings the StackRivet backend up locally with its OpenAPI explorer, assuming you already have the stackrivet-server repository checked out. For the full setup — cloning the repositories, running the admin UI and configuration — see Installation.

Prerequisites

• JDK 21 (the default supported major; major framework upgrades use dedicated branches)
• Maven 3.9+
• Docker — to run MySQL and Redis locally

1. Start the data stores

The default profile uses MySQL + Redis. Redis backs JWT revocation and the Actuator health check, so it is required.

docker compose up -d mysql redis

Add postgres only if you set STACKRIVET_DB_VENDOR=postgresql; add minio only if you set STACKRIVET_STORAGE_TYPE=s3. See Configuration for the common environment variables.

2. Build the reactor

The backend is a modular monolith of 16 Maven modules. Build them all once:

mvn install -DskipTests=true

3. Run the application

stackrivet-app is the Spring Boot entry point that assembles every business module into the runnable application:

mvn -pl stackrivet-app spring-boot:run

4. Open the OpenAPI explorer

Once the app has started, open the interactive API docs:

open http://127.0.0.1:8080/swagger-ui.html

On Linux or Windows, just visit http://127.0.0.1:8080/swagger-ui.html in your browser.

Run the admin UI

To use the Vue admin interface, start the frontend from the stackrivet-admin-ui repository (it proxies /api/* and /actuator/* to the backend on port 8080):

pnpm install
pnpm dev          # http://127.0.0.1:5173/

Requires Node 24 and pnpm 11.

Next steps

• Project Structure — how the repositories and modules fit together.

Continue with the guides for generating modules, configuring object storage and deployment.