Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 4.21 KB

carbongrid.adoc

File metadata and controls

63 lines (46 loc) · 4.21 KB

CarbonGrid - Project Portfolio

PROJECT: ClerkPro


Overview

ClerkPro is a desktop application designed for ease of managing clinic’s appointments, queue and scheduling. The user interacts with it using a CLI, and it has a graphical user interface (GUI) created with JavaFX. It is written in Java, and has about 17 kLoC (cross verified at https://codetabs.com/count-loc/count-loc-online.html & http://line-count.herokuapp.com/AY1920S1-CS2103T-T09-3/main).

Summary of contributions

  • Major enhancement: Major Rework on User Interface (UI) with AutoComplete with flags.

    • What it does: Reduces the mental workload & visual fatigue of user from having to carefully type commands and double checking the typed command or the user guide for supported commands and parameters.

    • Justification: Enhances the user experience (UX) design significantly because it provides optimal focus on primary tasks at hand to reduce visual and cognitive expenditure.

    • Highlights: Affects interaction against existing UI components as the traversal have to be critically handled from component to component.

    • Credits: None

  • Major enhancement: Reactive Search (Proposal & UX Concept)

    • What it does: Prevents un-necessary waiting by the user.

    • Justification: Enhances the UX significantly as user no longer waits to preview the number of possible results.

    • Highlights: Reactive Search should not block the main UI from user upon processing large data-sets.

    • Credits: SakuraBlossom (Threading and Logic), Google & Chrome DevTools Console (Inspiration)

  • Minor enhancement: added history for the CLI that allows the user to navigate to previous commands using up/down keys.

  • Code contributed: [Link to Reposense]

  • Other contributions:

    • Project management:

      • Updating Gradle wrapper & Configuration for Headed UI Test (Pull Request #71, #89)

      • Gradle Plugin & Dependencies management, version bumping for dependencies bug fixes & optimisations after compatibility checks. (Pull requests #80, #100, #200)

      • Setting up Netlify for team repository.

    • Enhancements to existing features:

      • Implemented TestFX for minimalistic UI testing to increase coverage from 56.193% to 73.193% (Pull request #71)

      • Implemented more UI testing increasing coverage from 67.652% to 73.091% (Pull request #217)

    • Community:

      • PRs reviewed (with non-trivial review comments): #86, #78

      • Contributed to forum discussions (examples: 1)

      • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)

    • Tools:

      • Integrated a third party library (TestFX) to the project (#71)

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.