Yong Kai Qi's Project Portfolio Page
Project: TrackBeau
Overview
TrackBeau is a desktop app made for beauty salons to aid them in managing customers’ profile, bookings and services. It is optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). It is written in Java, and has about 10 kLoC.
Summary of contributions
Given below are my contributions to the project.
- New Feature: Added the ability to manage services available in the beauty salon.
- What it does: Allows the user to create, update, delete service and view all services.
- Justification: This feature is crucial as beauty salons needs to keep track of the services that they have and also make use of it for bookings of services.
- New Feature: Added the ability to edit customers of the beauty salon.
- What it does: Allows the user to update the information of a customer.
- Justification: This feature is crucial as the customer’s information might change over time and the beauty salon has to stay up-to-date on the information.
- Enhancements to existing features:
- Revamp the overall GUI to suit the theme of TrackBeau and the various features it has.
- Improved code quality by abstracting codes to avoid code duplication
-
Code contributed: Around 2kLoC contribution to the project RepoSense link
- Documentation:
- User Guide:
- Added sections 3, 4.2.1, 4.2.2, 4.2.3, 4.2.4, 4.2.6 and 6.
- Developer Guide:
- Updated Design - UI component, Logic component, Model component, Storage component (with the exception of the sequence diagram for delete customer(s) command in Logic component) section.
- Added List customers, Add service, Edit service feature in the Implementation section.
- Updated user stories
- Restructured use cases and added UC01, UC03, UC05, UC07, UC08, UC09, UC10
- User Guide:
- Team Task:
- Set up the GitHub team org and repo
- Maintaining the issue tracker
- Updating user docs that are not specific to a feature
- Community:
- Reviewed and merged PRs for team members.
- Reported bugs and gave suggestions to other teams during the dry run of the practical examination repository: ped
- Helped peers in the module via the module’s GitHub website’s forum issues #233