Skip to content

Latest commit

 

History

History
172 lines (119 loc) · 9.02 KB

amoscheong97.adoc

File metadata and controls

172 lines (119 loc) · 9.02 KB

Amos Cheong - Project Portfolio

PROJECT: Delino

Overview

Delino is a desktop application for couriers to manage delivery tasks. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 16 kLoC.

Summary of contributions

  • Major enhancement:

    • Added insert command (Pull request #189)

      • What it does: Allows the user to insert new delivery order into the Order List. The user can add an order that contains the following attributes : Transaction ID, Name of Customer, Phone, Email, Address, Delivery Timestamp, Warehouse location, Cash on Delivery, Comment (Optional) and Type of Item (Optional)

      • Justification: This is an important feature and it is a must-have. It allows user to insert multiple orders into the list.

    • Refactor the list command (Pull request #239)

      • What it does: Instead of simply displaying all the orders, the user can choose to list :

        • Delivered orders

        • Undelivered orders

      • Justification: The feature helps the user, as a courier, to know how many orders have to be completed and how many orders are already completed.

    • Added the show command (Pull request #199)

      • What it does: It gives a more detailed information about the orders and return orders in their lists, in the form of numbers and PieChart. The information shown is :

        • Total Earnings

        • Orders Completed

        • Orders Returned

        • A PieChart to show to the user on how many orders are completed and not completed, returned and not returned.

    • Highlights:
      Ability to let user to see information based on the date(s) provided. For example, the user can enter : show 2020-02-02 2020-09-01 to see all the information about the orders that are from the date 2020-02-02 up to the date 2020-09-01. In addition, user can show statistics about everything in all the lists or just simply showing the statistics for today.

    • Credits: UI Design ideas for show Command from https://www.youtube.com/watch?v=UDi051XyQ-U&t=339s

  • Minor enhancement:

    • Fix bugs for the Application (Pull requests #309, #233)

      • What it does: Restricts user from entering any invalid values

      • Justification: This is an essential update, as the invalid values will affect the rest of the features.

  • Code contributed: [Functional code and Test code]

  • Other contributions:

    • Project management:

      • Responsible for ensuring that the team’s code is compliant with the coding standards and in charge of defining, assigning and tracking all project tasks.

    • Enhancements to existing GUI:

      • Make major changes to the UI to change from Window to TabView (Pull request #318)

    • Documentation:

      • Add Manual Testing Instructions for Developer Guide. (Pull request #81)

      • Update Developer Developer Guide. (Pull requests #171, #252)

    • Community:

      • PRs reviewed (with non-trivial review comments): (Pull requests #299, #227, #218, #193, …​)

    • Tools:

      • Integrated a third party library (Netlify) to the project (#1708e0b)

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.

Features

Insert feature

This whole section of the Insert feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

List feature

This whole section of the List feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Show feature

This whole section of the Show feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

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.

Features

Insert feature

This whole section of the Insert feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

List feature

This whole section of the List feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Show feature

This whole section of the Show feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Use Cases

Use case for insert feature

This whole section on Use case for insert feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Use case for show feature

This whole section on Use case for show feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Use case for list feature

This whole section on Use case for list feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Glossary

This whole section on Glossary can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Appendix G: Instructions for Manual Testing

Manual Testing for insert

This whole section on manual testing for insert feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Manual Testing for list

This whole section on manual testing for list feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member

Manual Testing for show

This whole section on manual testing for show feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member