Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 3.17 KB

jiaqingtan.adoc

File metadata and controls

59 lines (37 loc) · 3.17 KB
Raw

Tan Jiaqing - Project Portfolio

PROJECT: Concierge

Overview

Concierge is a desktop application simulating a hotel management system used by hotel owners and receptionists. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

Summary of contributions

  • Code contributed: [Code Contributed]

  • Major enhancements:

    • Expanding on the existing list function:

      • What it does: It allows the user to list between seeing a list of all guests, list of checked-in guests, or a list of all the rooms in the hotel.

      • Justification: This feature is essential to a proper, working hotel management system. The listing of information on guests and rooms is needed for receptionists to perform follow-up tasks, be it in person or within the app.

      • Highlights: The listing function was made with the intention of listing guests and rooms separately under the same column by modifying JAVAFX and FXML files.

      • Credits: Additional credit should also be given to my groupmate Adam Chew (adamwth), who added the functionality of list checked-in guests with the list -cg command.

    • Expanding on the existing find function:

      • What it does: It allows the user to search for all guests, checked-in guests, or rooms based on a particular set of conditions/predicates related to the attributes of the guest/room.

      • Justification: This feature is essential to a proper, working hotel management system. The find function can be used in a multitude of scenarios, such as when a quick search of rooms of an exact capacity is needed, or when a checked-in guest needs to be located immediately, in the event of an emergency.

      • Highlights: The prefixes of the find function can be chained in any order, and in any quantity, as the predicates are all combined at the end. Each filter is has an "and" relationship with one another.

      • Credits: The modification of the find function was dependent on its own initial code, and the style of coding and arriving at the solution was closely followed.

  • Other contributions:

    • Replacing the HTML panel with a focused/detailed panel - #145

    • Modifying the FXML files to list guest and rooms under the same UI column/panel - #145

    • Creation of the Concierge Icon and Logo - #46

Contributions to the User Guide

Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users.

Contributions to the Developer Guide

Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.