Installation manual

🔧 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 (or a compatible version)
• Apache Maven
• An internet connection (required for fetching organization data)
• An IDE (recommended):
  • IntelliJ IDEA
  • Visual Studio Code (with Java Extension Pack)

---

1. Download the Project

Clone the repository from GitHub:

git clone https://git.ntnu.no/Group-5/Help-Me-Help.git

Alternatively, download the project as a ZIP file and extract it.

---

2. Open the Project

1. Open your IDE
2. Select Open Project / Open Folder
3. Choose the root folder (the one containing pom.xml)

---

3. Build the Project

Open a terminal in the project folder and run:

mvn clean compile

This step will download all required dependencies and compile the source code.

---

4. Run the Application

Start the application with:

mvn javafx:run

After a few seconds, the application window should appear.

---

5. Database Information

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

---

6. Troubleshooting

Application does not start

• Make sure the correct Java version is installed
• Try reloading Maven dependencies in your IDE

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

---

7. Uninstalling the Application

To remove the application:

• Simply delete the project folder from your computer

---