-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
53 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,11 +5,20 @@ | |
| - [Technologies Used](#technologies-used) | ||
| - [Implementation Details](#implementation-details) | ||
| - [Known Bugs](#known-bugs) | ||
| - [Setup and Installation](#setup-and-installation) | ||
| - [About the Team](#about-the-team) | ||
| - [Contact Information](#contact-information) | ||
|
|
||
| ## About the App | ||
| The SoftEng Health Club is known for its commitment to member satisfaction. It aims to enhance its services with a new membership management system. As the club grows, it seeks to streamline operations and improve communication with its members. This system will help SoftEng efficiently manage memberships, handle renewals, and support better member engagement. With a focus on maintaining its reputation for excellent service. This new system will ensure both staff and members enjoy a smooth experience. The system will be designed to handle various membership durations, notify members of upcoming renewals, and allow for on-the-spot membership renewals and sign-up. Additionally, it will offer tools for the club’s management to monitor member activity and generate reports for operational decisions. The following document outlines the complete design needed to meet these objectives and ensure smooth operation for both members and staff. The SoftEng Health Club's suggested membership management system is made to specifically address the demands of both the club and its customers. This solution will increase membership satisfaction by emphasizing automation, user experience, and data insights through specialized latent tasks. | ||
| The SoftEng Health Club is known for its commitment to member satisfaction. It aims to enhance its services with a new membership management system. As the club grows, it seeks to streamline operations and improve communication with its members. This system will help SoftEng efficiently manage memberships, handle renewals, and support better member engagement. With a focus on maintaining its reputation for excellent service, this new system will ensure both staff and members enjoy a smooth experience. | ||
|
|
||
| The system is designed to: | ||
| - Handle various membership durations. | ||
| - Notify members of upcoming renewals. | ||
| - Allow on-the-spot membership renewals and sign-ups. | ||
| - Provide tools for management to monitor member activity and generate reports for informed decision-making. | ||
|
|
||
| This document outlines the complete design needed to meet these objectives, ensuring seamless operation for both members and staff. The SoftEng Health Club's membership management system is crafted to address the demands of both the club and its members, emphasizing automation, user experience, and data insights. | ||
|
|
||
| ## Technologies Used | ||
| - **Java**: Primary programming language for backend development. | ||
|
|
@@ -18,32 +27,57 @@ The SoftEng Health Club is known for its commitment to member satisfaction. It a | |
|
|
||
| ## Implementation Details | ||
|
|
||
| The SoftEng Health Club Membership Management System comprises several Java classes and interfaces, each responsible for specific functionalities that ensure robust operation and maintainability. Here's an overview of the key components: | ||
|
|
||
| ### Database Integration: | ||
|
|
||
| - Utilizes MySQL for data storage, managing members' data, session logs, and authentication details. | ||
| - Connection and query executions are managed through standard JDBC API calls, ensuring reliable data transactions and security against SQL injection via prepared statements. | ||
| - Connection and queries are handled through the JDBC API, ensuring reliable data transactions. | ||
| - Uses prepared statements to safeguard against SQL injection. | ||
|
|
||
| ### User Interface: | ||
| - Designed using Java Swing, providing a familiar native look and feel. | ||
| - The login page and other UI components utilize a `GridLayoutManager` to ensure responsive and user-friendly design on various screen resolutions. | ||
|
|
||
| - Designed using Java Swing, providing a native look and feel that is familiar to users. | ||
| - The login page is created with a combination of labels, text fields, and buttons laid out using a `GridLayoutManager` to ensure a responsive layout across different screen resolutions. | ||
| ## Known Bugs | ||
| - **Selection Issue After Sorting**: Selecting a member after sorting the table by a column currently selects the member previously at that row before sorting. This causes incorrect member actions. | ||
| - **Array Out of Bounds Error**: Clicking the delete button without selecting a member results in an ArrayOutOfBoundsException, potentially causing application crashes and data loss. | ||
|
|
||
| ## Setup and Installation | ||
| 1. **Install IntelliJ IDEA** | ||
| Download and install IntelliJ IDEA from [JetBrains](https://www.jetbrains.com/idea/download/). | ||
|
|
||
| ## Known Bugs | ||
| - **Selection Issue After Sorting**: Selecting a member after sorting the table by column selects the member that was in the row before sorting. This can lead to incorrect member actions and needs attention to ensure accurate data manipulation. | ||
| - **Array Out of Bounds Error**: An array out of bounds error occurs when the delete button is clicked without selecting a member. This error can crash the application, leading to potential data loss and reduced system stability. | ||
| 2. **Install JavaFX Plugin** | ||
| In IntelliJ, go to `File > Settings > Plugins` and search for "JavaFX" to install the required plugin. | ||
|
|
||
| 3. **Configure Source Directories** | ||
| After cloning the repository, right-click on the `src` and `res` directories in the Project pane and select: | ||
| `Mark Directory as > Source Directory` | ||
| This ensures IntelliJ recognizes them as part of the project's source structure. | ||
|
|
||
| 4. **Set JDK to Temurin 17** | ||
| Go to `File > Project Structure > Project` and set the "Project SDK" to `temurin-17` (or another JDK 17 distribution you have installed). | ||
|
|
||
| ## About the Team | ||
| This project is developed by a dedicated team of software engineering students from the COMP330 course. The team has embraced the challenge of developing a robust membership management system and has shown exceptional commitment to continuous improvement and clear communication. | ||
| This project is developed by a dedicated team of software engineering students from the COMP330 course, who have demonstrated commitment to building a reliable membership management system, emphasizing continuous improvement and open communication. | ||
|
|
||
| ## Contact Information | ||
| For more details about the project, or to reach out with questions or suggestions, please contact the following team members: | ||
| - **Nahum Gessesse** - Developer - Email: [[email protected]](mailto:[email protected]) | ||
| - **Xander Estevez** - Developer - Email: [[email protected]](mailto:[email protected]) | ||
| - **Manali Deb** - QA/Technical Writer - Email: [[email protected]](mailto:[email protected]) | ||
| - **Alina Zacaria** - Tech Lead - Email: [[email protected]](mailto:[email protected]) | ||
| - **Andrew Do** - Developer - Email: [[email protected]](mailto:[email protected]) | ||
| - **Nick Calhoun** - Developer - Email: [[email protected]](mailto:[email protected]) | ||
| - **Jai Fischer** - Developer - Email: [[email protected]](mailto:[email protected]) | ||
| For more details or inquiries, please contact: | ||
|
|
||
| - **Nahum Gessesse** - Developer | ||
| Email: [[email protected]](mailto:[email protected]) | ||
|
|
||
| - **Xander Estevez** - Developer | ||
| Email: [[email protected]](mailto:[email protected]) | ||
|
|
||
| - **Manali Deb** - QA/Technical Writer | ||
| Email: [[email protected]](mailto:[email protected]) | ||
|
|
||
| - **Alina Zacaria** - Tech Lead | ||
| Email: [[email protected]](mailto:[email protected]) | ||
|
|
||
| - **Andrew Do** - Developer | ||
| Email: [[email protected]](mailto:[email protected]) | ||
|
|
||
| - **Nick Calhoun** - Developer | ||
| Email: [[email protected]](mailto:[email protected]) | ||
|
|
||
| - **Jai Fischer** - Developer | ||
| Email: [[email protected]](mailto:[email protected]) | ||