oqm-core-api

open-qm-base-station

This project is the server providing the core functionality of Open QuarterMaster.

Additional docs can be found in the docs folder, along with at the main project readme.

TL;DR getting started:

More detail in this guide

Prerequisites:

1. Java runtime and dev kit version 11 (official or open is fine)
2. Docker (podman might also work, with some tweaks)

Common Commands

Running in dev mode

Dev mode allows you to run this service in a way that facilitates development. Changes are automatically recompiled and served, along with dev resources like Mongo and Kafka being stood up for you.

./gradlew quarkusDev

Dev ui at: http://localhost:8080/q/dev/

Swagger at: http://localhost:8080/openapi-ui/index.html

Tests

Regular set of tests:

./gradlew test