Skip to content

Commit

Permalink
fix[readme]: change interface to abstract when elaborating project st…
Browse files Browse the repository at this point in the history
…ructure
  • Loading branch information
Fredrik Marjoni committed Apr 23, 2026
1 parent 1d94ded commit 17470d8
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Help-Me-Help - IDATT1005 Team 5 Portfolio Project Spring 2026 :octocat:

**TEAM 5 STUDENT NAMES**

<br>
Expand Down Expand Up @@ -61,8 +62,8 @@ src/main/java/edu/group5/app/
│ │ ├── DbWrapper.java (H2 database connection & operations)
│ │ └── OrgApiWrapper.java (Innsamlingskontrollen API client)
│ ├── AppState.java (Global application state)
│ ├── Repository.java (Base repository interface)
│ └── DBRepository.java (Database repository interface)
│ ├── Repository.java (Base repository abstract)
│ └── DBRepository.java (Database repository abstract)
|
├── view/ (JavaFX UI components)
│ ├── loginpage/
Expand Down Expand Up @@ -108,7 +109,6 @@ src/main/resources/ (Static assets - CSS, images,
└── donationpage.css (Donation flow styling)
</pre>


### 📦 Package Responsibilities

#### Models: Business logic and data entities
Expand Down Expand Up @@ -178,7 +178,7 @@ The project uses the standard Maven directory structure, which ensures:

## Link to repository📚

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

## How to run the project📝

Expand Down Expand Up @@ -207,6 +207,7 @@ https://git.ntnu.no/Group-5/Help-Me-Help
```bash
mvn javafx:run
```

```


Expand All @@ -216,6 +217,7 @@ https://git.ntnu.no/Group-5/Help-Me-Help
Go to repository and download the JAR.

2. Run the JAR in Terminal:

```bash
java --module-path "path\to\javafx\sdk" --add-modules javafx.controls -jar path\to\jar.jar
Expand Down Expand Up @@ -274,7 +276,6 @@ Each report includes:
3. Execution times
4. Running tests in an IDE


## References 🔗

For more references and project details, kindly refer yourself to the project report and Wiki pages
Expand Down

0 comments on commit 17470d8

Please sign in to comment.