Skip to content

Commit

Permalink
chore&update[README]: update installation guide and remove TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucy Ciara Herud-Thomassen authored and Lucy Ciara Herud-Thomassen committed Apr 23, 2026
1 parent 88f5663 commit 1d94ded
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ src/main/resources/ (Static assets - CSS, images,
└── donationpage.css (Donation flow styling)
</pre>

[//]: # (TODO: Describe the structure of your project here. How have you used packages in your structure. Where are all sourcefiles stored. Where are all JUnit-test classes stored. etc.)

### 📦 Package Responsibilities

Expand Down Expand Up @@ -177,47 +176,49 @@ The project uses the standard Maven directory structure, which ensures:
- compatibility with IDEs such as IntelliJ, VS Code, and Eclipse
- maintainability and easy future extensions (e.g., persistence or additional views)

---

## Link to repository📚

[//]: # (TODO: Include a link to your GitHub repository here.)
[GitHub Repository - IDATT1005 Project Spring 2026](https://git.ntnu.no/Group-5/Help-Me-Help)

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

## How to run the project📝

[//]: # (TODO: Describe how to run your project here. What is the main class? What is the main method?
What is the input and output of the program? What is the expected behaviour of the program?)

**Requirements:**

- Java JDK 25
- Maven
- IDE (Ideally IntelliJ or VSCode with Java Extension Pack)
- JavaFX SDK 25.0.1--

**Steps:**
**Run With Maven:** (Windows + Mac + Linux)

1. **Clone repository**
Clone the Repository from GitHub
1. **Download and Unzip Project:**
Download project zip from the repository.

2. **Open the Project:**
Open your IDE and select **File > Open Folder**, navigating to the root folder of the project (containing `pom.xml`).
2. **Navigate to Project Folder:**
Navigate to project folder in the terminal.

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

3. **Build the Project:**
Open the terminal in your IDE (`Ctrl + ~`) and run:
3. **Run the Application:**
Start the program by running the main class:

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

```bash
mvn clean compile

4. **Run the Application:**
Start the program by running the main class:

**Run From JAR: (Windows)

1. Download Project JAR:
Go to repository and download the JAR.

2. Run the JAR in Terminal:
```bash
mvn javafx:run
5. **Input and Output**
java --module-path "path\to\javafx\sdk" --add-modules javafx.controls -jar path\to\jar.jar
- Input: User interactions (login, organization selection, donation amount)
- Output: JavaFX UI displaying organizations, user profiles, donation confirmations
Expand Down Expand Up @@ -273,7 +274,6 @@ Each report includes:
3. Execution times
4. Running tests in an IDE

[//]: # (TODO: Describe how to run the tests here.)

## References 🔗

Expand Down

0 comments on commit 1d94ded

Please sign in to comment.