Skip to content

Installation manual

Lucy Ciara Herud-Thomassen edited this page Apr 23, 2026 · 6 revisions

Installation Manual🔧 – Help-Me-Help (HmH)

Overview

This guide explains how to install and run the Help-Me-Help application on your computer.
The application is a JavaFX desktop system built using Maven.


Requirements

Before you begin, make sure you have the following installed:

  • Java JDK 25
  • Maven
  • JavaFX SDK 25.0.1--

Run With Maven: (Windows + Mac + Linux)

1. Download and Unzip Project:

Download project zip from the repository.

2. Navigate to Project Folder:

Navigate to project folder in the terminal:

cd path/to/project/     (linux + mac)
cd path\to\project\     (windows)

3. Run the Application:

Start the program by running the main class:

mvn javafx:run

Run From JAR: (Windows)

1. Download Project JAR:

Go to repository and download the JAR.


2. Run the JAR in Terminal:

java --module-path "path\to\javafx\sdk" --add-modules javafx.controls -jar path\to\jar.jar

Database Information

  • The application uses a H2 database
  • No manual setup is required
  • The database is automatically initialized when the application starts

Troubleshooting

Application does not start

  • Make sure the correct Java version is installed

Maven command not found

  • Ensure Maven is installed and added to your system PATH

Organizations are not loading

  • Check your internet connection
  • Verify that the Innsamlingskontrollen API is available

Uninstalling the Application

To remove the application:

  • Simply delete the project folder/jar from your computer