Skip to content

paulbrenker/trailmenu

Repository files navigation

Trailmenu

Trailmenu is the central backend service for the Trailmenu Outdoor Meal Planner. It provides HTTP REST endpoints for core functionallity, along with built-in user and authentication management.

Swagger UI


📑 Table of Contents


🚀 Getting Started

This project requires Java 21 (Temurin distribution).
We recommend installing it via SDKMAN:

sdk install java 21-tem

Database

A local PostgreSQL instance is required. You can start it with Docker:

docker compose up -d postgres

Run the app

For development purposes, run the application using:

./gradlew bootRun

Alternatively, you can build and run the full stack (app + database) with Docker:

docker compose up --build```

OpenAPI

API endpoints and authentication are documented via OpenAPI & Swagger UI.

Testing

Run tests with:

./gradlew test
  • Test coverage is automatically enforced at 80%.
  • Coverage reports can be found here: Jacoco Report .

About

Kotlin & Spring Boot Backend Server to plan meals for Outdoor Trekking Adventures

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages