quickstart.md

Quickstart of the Server

Table of Contents

1. Configuration
2. Running locally
   1. Build the Server
   2. Run the Server
   3. Run the Server with Debug
   4. Stop the Server

Configuration

Refer to the Configuration for configuration options.

Running locally

• Server subproject qualifier: :block-node: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. :block-node: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:

./gradlew clean build -x test

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

   ./gradlew clean build -x test

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

   ./gradlew clean qualityGate build runSuites

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

   ./gradlew :block-node:app:createDockerImage

Run the Server

1. To start the Server, do the following:

   ./gradlew :block-node:app:startDockerContainer

Run the Server with Debug

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

   ./gradlew :block-node:app:startDockerDebugContainer

2. Attach your remote jvm debugger to port 5005.

Stop the Server

1. To stop the Server do the following:

   ./gradlew :block-node:app:stopDockerContainer