From abcc56163443bc05905a1498307359ca665b771f Mon Sep 17 00:00:00 2001 From: Nahum Gessesse <99192972+nahumguess@users.noreply.github.com> Date: Sat, 23 Nov 2024 16:44:27 -0600 Subject: [PATCH 1/2] README initial commit. Will be updated as code gets pushed --- README.md | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ac5a299..3d56840 100644 --- a/README.md +++ b/README.md @@ -1 +1,40 @@ -# softeng-health-club-app \ No newline at end of file +# SoftEng Health Club Membership Management System + +## Table of Contents +- [About the App](#about-the-app) +- [Technologies Used](#technologies-used) +- [Implementation Details](#implementation-details) +- [Testing Details](#testing-details) +- [Known Bugs](#known-bugs) +- [About the Team](#about-the-team) +- [Contact Information](#contact-information) +- [License](#license) + +## 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. + +## Technologies Used +- **Java**: Primary programming language for backend development. +- **MySQL**: Database management system for storing and retrieving all membership data. + +## Implementation Details +[To be completed] + +## Testing Details +[To be completed] + +## Known Bugs +[To be noted] + +## 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. + +## 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 +- **Xander Estevez** - Developer +- **Manali Deb** - QA/Technical Writer +- **Alina Zacaria** - Tech Lead +- **Andrew Do** - Developer +- **Nick Calhoun** - Developer +- **Jai Fischer** - Developer From b199f6fbf5a1328c046441b240ae1b6a3810435f Mon Sep 17 00:00:00 2001 From: Nahum Gessesse <99192972+nahumguess@users.noreply.github.com> Date: Sat, 23 Nov 2024 16:44:48 -0600 Subject: [PATCH 2/2] Update README.md - remove license section --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 3d56840..c9fcb89 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ - [Known Bugs](#known-bugs) - [About the Team](#about-the-team) - [Contact Information](#contact-information) -- [License](#license) ## 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.