Kvasir Documentation master Help

Getting started

Running with Docker Compose

The fastest way to get a dev server (with persistent storage) up and running is to use Docker Compose.

Clone this repository and run the following commands:

cd .deployment/docker-compose docker compose up -d

This will automatically create a pod at http://localhost:8080/alice for you to play with. The settings for this pod can be modified via the file application.yaml in the kvasir-config folder.

Running on Kubernetes

(A guide will be added in the future)

Running in dev mode

If you want to experiment with modifications to the code, you can run the server in dev mode via the Maven wrapper. This requires you to have Java JDK 21 installed.

docker compose up -d ./mvnw compile quarkus:dev

Issues

The project is still in a very early stage of development, so there are many issues and missing features. If you find any, please report them in the Issues section.

Last modified: 28 November 2024