About The Project

This project is a simple application built as part of our school assignment. It allows users to check the current status of the in-house counters.

Getting Started

If you want to setup the project locally, you need the following dockers. Configs can be set in the /src/main/resources/application.local-properties. Also you have to create a /src/main/resources/database.properties file. There is an example. Postgres (recommended): We are using the image: postgres:alpine with the normal postgres port 5432. Pgadmin (recommended): We are using the image: pgadmin4:8

Prerequisites

This is a list of tools you need to use and how to install them.

• JDK 23
• Docker
• Docker Compose (Linux only)

Installation

1. Clone the repo

   git clone https://github.com/BS-Info-Gruppe-A/backend.git
   cd backend

2. Generate ~/.m2/toolchains.xml (manually copy the xml from the below command into the file)

   ./mvnw toolchains:generate-jdk-toolchains-xml

3. Start database server )if needed)

   docker compose -f dev.docker-compose.yaml up -d

4. Change config of service (replace VornameNachname with your OS username in the copied file)

   mkdir -p ~/bsinfo-projekt/
   cp src/main/resources/database.properties.example ~/bsinfo-projekt/database.properties

Tasks

Running

In order to run this project, use your IDE to run the Launcher.java file. Please note that the only supported Java Version is Java 23 with preview features enabled (--enable-preview)

Running tests

To run tests execute ./mvnw test in a POSIX compliant shell (cmd is not supported, use PowerShell)

Generating project report

To run tests execute ./mvnw site in a POSIX compliant shell (cmd is not supported, use PowerShell) The generated report will be in target/site/index.html

Usage

This is only a project for school requirements. There is no productive use yet.

Roadmap

• JDBC
• JUnit Test
• Rest

See the open issues for a full list of proposed features (and known issues).

Thanks for checking out the project!