Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 61 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,69 @@
# Welcome to the "Help Me Help" (HmH) Project Wiki

**Course:** IDATx1005 Software Engineering 2026
# Help Me Help (HmH)

**Course:** IDATx1005 Software Engineering 2026
**Group:** 3

---

## The Team
* **Aksel Kirkhorn**
* **Elisabeth Berg**
* **Erik Aasen**
* **Johanna Krogh Anderson**
- **Aksel Kirkhorn**
- **Elisabeth Berg**
- **Erik Aasen**
- **Johanna Krogh Anderson**

---

## About the Project
Help Me Help (HmH) is a software engineering project developed as part of the course **IDATx1005 Software Engineering 2026**.

The purpose of the application is to make it easier for users to find and explore charitable organizations in a structured and trustworthy way.

---

## Requirements
Before starting the application, make sure you have the following installed:

- Java 21 (JDK 21)
- Maven
- A terminal or IDE such as IntelliJ IDEA, PowerShell, Command Prompt, or Terminal

---

## How to Start the Application

This project uses Maven to build and run the application.

### Windows
Open **PowerShell** or **Command Prompt** in the project root folder and run:

```bash
mvn clean javafx:run
```

### macOS
Open **Terminal** in the project root folder and run:

```bash
mvn clean javafx:run
```

---

## How to Open Javadoc

The project Javadoc is available in the `docs/javadoc` folder.


### Windows
Open it directly from **PowerShell** or **Command Prompt** in the project file with:

```powershell
start docs\javadoc\index.html
```

### macOS
Open it directly from **Terminal** in the project file with:

```bash
open docs/javadoc/index.html
```
Loading