Skip to content

Latest commit

 

History

History
190 lines (109 loc) · 5.03 KB

Celine.adoc

File metadata and controls

190 lines (109 loc) · 5.03 KB

Lim Pei Yi, Celine - Project Portfolio

Project: cherBook

cherBook - is a desktop address book application used for teachers and educators. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java.

Code contributed: [Functional code] [Test code]

Enhancement Added: Sort Command [v1.2]

External behavior


Start of Extract [from: User Guide]

End of Extract


Justification


Start of Extract [from: Developer Guide]

End of Extract


Implementation


Start of Extract [from: Developer Guide]

End of Extract


Enhancement Added: Extended Person Card Panel [v1.3]

External behavior


Start of Extract [from: User Guide]

ExtendedPersonCard

This figure shows how the Extended Person Card looks like in cherBook. It contains all the information of a student.

End of Extract


Justification


Start of Extract [from: User Guide]

End of Extract


Enhancement Added: Schedule Command [v1.4]

External behavior


Start of Extract [from: User Guide]

End of Extract


Justification


Start of Extract [from: Developer Guide]

End of Extract


Implementation


Start of Extract [from: Developer Guide]

End of Extract


Enhancement Added: View Schedule Command [v1.5]

External behavior


Start of Extract [from: User Guide]

End of Extract


Justification


Start of Extract [from: Developer Guide]

End of Extract


Implementation


Start of Extract [from: Developer Guide]

End of Extract


Enhancement Added: Delete Schedule Command [v1.5]

External behavior


Start of Extract [from: User Guide]

End of Extract


Enhancement Proposed: Use Postal Code to display Google Map of student’s address

External behavior

Clicking the Postal Code attribute displayed on the Student Details panel would open a Google Map panel that displays the map of the student’s address. The map would display the surroundings as well as provide all possible ways to get to the student’s house.

Justification

Sometimes when students fall sick for a long period of time, they might face huge difficulties in trying to catch up with their studies. The reason for this implementation is so that users of cherBook (teachers / educators) have the ability to conduct house visits easily to update their student on the school-related assignments, as well as to show concern for the student.

Implementation

Link the Postal Code attribute to Google Map panel whereby the map would display the vicinity of the student’s address. Google API would be called and the Postal Code of the user’s current and designated location would be parsed before the map and routes are displayed and calculated respectively.

Enhancement Proposed: Use Schedules to remind users (teachers / educators) about their meetings and appointments

External behavior

No external behaviour. The teacher only has to enter their schedules into cherBook. cherBook will automatically remind them ten minutes before when their scheduled date and time is due.

Justification

When teachers have many schedules to keep and meetings to attend in one day, and not forgetting their regular classes and duties, it is often hard for them to keep track of time.
Our cherBook application can make use of the schedules that the teacher has added and remind them ten minutes before any schedules are due. This is so that the teachers can focus on their work and let cherBook keep time for them instead.

Implementation

The clock function in cherBook is required to take note of the time and compare it with the date and time of every schedule in the schedule list.
cherBook will produce a audible reminder ten minutes before every scheduled appointment.

Other contributions