Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
meenaksj authored Apr 21, 2026
1 parent 29577e5 commit 168ddc7
Showing 1 changed file with 35 additions and 14 deletions.
49 changes: 35 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,31 +49,38 @@ Only organizations approved by **Innsamlingskontrollen (IK)** will be listed in
## Core Functionalities

The application provides the following functionalities:
- [ ] User profile creation and management
- [ ] Display of verified aid organizations
- [ ] Donation tracking (history and planned donations)
- [ ] Search and filtering of organizations
- [ ] Favorites or recommendation feature
- [ ] Retrieveal og organization data from API or CSV
- [ ] donation tracking (basic functionality)
- [ ] Basic user related functionality (password hashing,...)

- Display of verified aid organizations
- Basic user related functionality (password hashing,...)
- Retrieveal og organization data from API or CSV
- Basic donation tracking functionality

The following features are part of the original project scope but are not fully implemented in the final version

- Full user profile manament
- Advanced search and filtering
- Favourites or recommenation system

## Technology Stack
- **Programming Language:** Java 25
- **Application Type:** Desktop application
- **UI:** JavaFX
- **Database:** Relational database
- **Database:** SQLite
- **Version Control:** NTNU GitHub (`https://git.ntnu.no/cathrkri/systemutviklingTeam6/tree/main`)
- **Documentation:** GitHub Wiki, JavaDoc, GitHub Pages, teams


## Architecture & Design

- Architectural style:
- Domain model
- Use-case diagram
- Design principles:
The application follows a layered architecture:

- Presentation layer: JavaFX based user interface
- Application layer: Handles ccore logic and coordination
- Data layer: Database and external data handling

The domain model includes key entities such as Charity, Donation and user related components.

Design principles applied:
- Don Norman’s principles of interaction design
- Universal Design
- Sustainability considerations
Expand Down Expand Up @@ -112,10 +119,24 @@ The project is carried out in **three iterations**, consisting of multiple sprin

## How to Run the Application
1. Clone the repository
2. Open the project in your IDE
2. Open the project in your IDE (with Java 25 support)
3. Configure the database
4. Run the main application class

## Scalability and Further Development
The application is designed with extensibility in mind, allowing for future improvements.
The system follows a modular and layered structure, separating the user interface, application logic, and data handling Which makes it easier to extend or modify individual parts of the system without affecting the entire application.
Currently, the application uses a relational database (SQLite), This can be replaced with a more scalable database solution, if the system is expanded to support multiple users or larger data.
Data retrieval is handled through both an external API and CSV input, which allows flexibility in integrating additional data sources in the future.

The domain structure (Charity, Donation, and user related components,...) is designed to support further functionality, such as:
- Full user account managment
- Advanced search and filtering
- Recommendation systems
- Integration with payment solutions

Overall, the current implementation provides a solid foundation for further development and scaling beyond the scope of this project.


## License
This project is developed for educational purposes as part of IDATx1005.
Expand Down

0 comments on commit 168ddc7

Please sign in to comment.