Soon Xiang, Yan's Project Portfolio Page
Project: GradPad
GradPad is an offline computer application meant to help Computer Science students from the National University of Singapore (NUS) plan their modules with more ease. All module information is displayed through our simple and organised Graphical User Interface (GUI) created with JavaFX. GradPad is also optimised for users who prefer working on a Command Line Interface (CLI). It is written in Java, and has about 13k LoC.
Given below are my contributions to the project.
-
New Feature: Added
required
command to check left-over required modules from the Computer Science Curriculum.-
What it does: Allows the user to check any undone required modules by cross-referring their current list of completed modules against the list of all the required modules that we store within GradPad. Modules are split into separate categories (Eg. Foundation, GE, Etc) for enhanced readability. The command also accounts for equivalent modules and preclusion (Eg. CS1010X & CS1101S).
-
Justification: This feature enhances the product significantly as users no longer have to refer manually to the NUS website, just to see a list of modules that they have not completed. Also, they do not have to manually filter our their completed modules, just to check what are the left-over modules, saving them loads of time during their module planning.
-
Highlights: This enhancement is a vital selling point of GradPad and will affect our future features. As the command deals with a lot of data and functionality, it required an in-depth analysis of design alternatives and OOP. The implementation was also tedious as it required a lot of testing. Initially, we used the provided JsonGradPadStorage class to read JSON file paths. However, we realised that our JAR release was not able to load the JSON files properly in runtime, due to pathing issues. Hence, with help from fellow teammate Lau Siaw Sam and some further study, we managed to find another way to read JSON files during runtime with the help of a ClassLoader, allowing our app to run smoothly during our release.
-
Credits: Read a file from resources folder
-
-
New Feature: Added
science
andgem
commands to check all the available Science and General Education Modules under the Computer Science Curriculum and in NUS respectively.-
What it does: Allows the user to check all the undone and available Science and General Education modules in the curriculum, based on their current list of modules accomplished.
-
Justification: This feature enhances the product as users no longer have to refer to the School website just to view the available Science Modules. It is separated from the
required
command from making the required command too cluttered, thus improving overall user experience. Separating the two commands also makes it easier to update our storage as we can now update our database for science modules without touching the other databases. Furthermore, General Education modules are also split according to Semester Availability which saves users more time. -
Highlights: This enhancement is vital to GradPad as it is part of our core
required
command feature. The command deals with a fair bit of data and testing, making the implementation slightly difficult. Faced the same issue as described above regarding accessing JSON files in our JAR release. -
Credits: Read a file from resources folder
-
-
Code contributed: RepoSense link
- Project management:
- Minutes Taker during meetings and consultations.
- Assign weekly workload to team.
- Provide feedback constantly, to teammate’s code. Comments made
- Enhancements to existing features:
- Refactored
Command
,Parser
andStorage
Component of AB3 code base (Pull request #35) - Updated
help
command to display instructions directly instead of a link to the UG. (Pull request #70) - Added Assertions to Model Component. (Pull request #99)
- Added tests to existing features to improve overall Test Coverage. (Pull requests #197, #204)
- Refactored
- Documentation:
- User Guide:
- Added documentation for the features
required
,science
,gem
,checkmc
, andexit
. (Pull requests #16, #117, #134) - Used Markdown to write Tips and Notes to make UG more visually stunning. (Pull requests #134, #218)
- Improved sentence structuring and language use in UG to make it more user-centric. (Pull requests #45, #70, #117, #134)
- Added documentation for the features
- Developer Guide:
- Added implementation details for the features
add
,required
,science
andgem
and the Storage Component. (Pull requests #45, #180 #218) - Added Introduction and ‘About This Guide’ section to the DG. (Pull request #70)
- Added Target User Profile, Value Proposition, User Stories and Use Cases to the DG. (Pull request #19)
- Added Manual Testing for all features to the DG. (Pull request #180)
- Refactored
Logic
component portion of DG. (Pull request #45)
- Added implementation details for the features
- User Guide:
- Community: