Skip to content

Commit

Permalink
update[*Readme]: update readme with better show of project structure …
Browse files Browse the repository at this point in the history
…and better display of references
  • Loading branch information
Fredrik Marjoni committed Apr 21, 2026
1 parent 8d9da1f commit 7ddebcc
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Help-Me-Help - IDATT1005 Team 5 Portofolio Project Spring 2026 :octocat:
# Help-Me-Help - IDATT1005 Team 5 Portfolio Project Spring 2026 :octocat:

[//]: # (TODO: Fill inn your name and student ID)
[//]: # (TODO: Mappe-2025-Marjoni-fj)
Expand Down Expand Up @@ -96,17 +96,20 @@ src/main/java/edu/group5/app/
└── utils/
└── ParameterValidator.java (Input validation utilities)

src/main/resources/
src/main/resources/ (Static assets - CSS, images, etc.)
├── header/
│ └── images/
│ └── hmh-logo.png
│ └── hmh-logo.png (Application logo)
├── loginpage/
│ └── loginpage.css
│ └── loginpage.css (Login/signup page styling)
├── homepage/
│ └── homepage.css
│ └── homepage.css (Home page styling)
├── causespage/
│ └── causespage.css
│ └── causespage.css (Organization browsing styling)
├── organizationpage/
│ └── organizationpage.css (Organization details styling)
└── donationpage/
└── 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.)
Expand Down Expand Up @@ -207,7 +210,7 @@ What is the input and output of the program? What is the expected behaviour of t
Open your IDE and select **File > Open Folder**, navigating to the root folder of the project (containing `pom.xml`).

3. **Build the Project:**
Open the terminal in yoru IDE (`Ctrl + ~`) and run:
Open the terminal in your IDE (`Ctrl + ~`) and run:

```bash
mvn clean compile
Expand All @@ -223,7 +226,7 @@ What is the input and output of the program? What is the expected behaviour of t
- Input: User interactions (login, organization selection, donation amount)
- Output: JavaFX UI displaying organizations, user profiles, donation confirmations
1. **Excpected behavior:**
1. **Expected behavior:**
<br>
The program allows the user to:
Expand Down Expand Up @@ -278,9 +281,10 @@ Each report includes:

## References 🔗

Innsamlingskontrollen API: <https://app.innsamlingskontrollen.no/api/public/v1/all>
<br>
For more references, they are included in the project report
For more references and project details, kindly refer yourself to the project report and Wiki pages

- **GitHub Wiki**: [GitHub Wiki](https://git.ntnu.no/Group-5/Help-Me-Help/wiki)

- **Innsamlingskontrollen API**: [Innsamlingskontrollen](https://app.innsamlingskontrollen.no/api/public/v1/all)

---
"""

0 comments on commit 7ddebcc

Please sign in to comment.