For the complete documentation index, see llms.txt. This page is also available as Markdown.

Local Development Quickstart

Table of Contents

Configuration

Refer to the Configuration for configuration options.

Running locally

  • Server subproject qualifier: :app

  • Assuming your working directory is the repo root

NOTE: one may use the -p flag for ./gradlew in order to avoid specifying the target subproject repeatedly on each task when running multiple tasks. When running only a single task, however, it is recommended to use the project qualifier (i.e. :app:) for both simplicity and clarity.

Build the Server

NOTE: if you have not done so already, it is generally recommended to build the entire repo first:

  1. To quickly build the Server sources (without running tests), do the following:

  2. Before building the server ensure your tests run successfully:

  3. To build the Server docker image, do the following:

Run the Server

  1. To start the Server, do the following:

Run the Server with Debug

  1. To start the Server with debug enabled, do the following:

  2. Attach your remote jvm debugger to port 5005.

Stop the Server

  1. To stop the Server do the following:

Last updated