Example Containerized JaxRS Service

Table of Contents

• Running the Example
  • Locally
  • In Docker
• Development

ℹ️	This repository is a thin demonstrative wrapper around the Core container library, for more in depth documentation of available features and config options see the core library’s readme.

Running the Example

Locally

Prerequisites

• Maven

• NodeJS/NPM

• Github credentials providing access to VEuPathDB packages

• Java v21+

Setup & Run

Environment/dependency setup for local development can be done via the command make install-dev-env. This will install the dependencies required to build the project.

After the environment has been set up, the project can be built, tested, and packaged using make jar.

Starting the server can be done by running java -jar build/libs/service.jar.

⚠️	Most projects will require some CLI or environment arguments to run. For a full listing of available options see the core container library documentation.

ℹ️	All project specific system level dependencies must be installed locally for this to work.

In Docker

Prerequisites

• Docker

• Docker Compose

Setup & Run

The project container can be built using make docker. The first build of the container will take several minutes.

Running the built container can be done with:

$ docker compose -f docker/docker-compose.dev.yml up

⚠️	Most projects will require some CLI or environment arguments to run. For a full listing of available options see the core container library documentation. When using docker-compose these options can be set automatically through the use of a .env file.

Development

TODO

Run make in the project directory to see available make targets.

Run ./gradlew tasks to see available gradle tasks.