From 07239f9ecfcd81078ef633579408aa21ae4f22a7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 11 Nov 2024 14:11:01 +0000 Subject: [PATCH] deploy: 9eb39e565b3db34eab3978c39d538bf2c5644e22 --- AboutUs.html | 2 +- AboutUs.page-vue-render.js | 2 +- Configuration.html | 2 +- Configuration.page-vue-render.js | 2 +- DevOps.html | 2 +- DevOps.page-vue-render.js | 2 +- DeveloperGuide.html | 5 +++-- DeveloperGuide.page-vue-render.js | 12 +++++++++--- Documentation.html | 2 +- Documentation.page-vue-render.js | 2 +- Logging.html | 2 +- Logging.page-vue-render.js | 2 +- SettingUp.html | 2 +- SettingUp.page-vue-render.js | 2 +- Testing.html | 2 +- Testing.page-vue-render.js | 2 +- UserGuide.html | 2 +- UserGuide.page-vue-render.js | 2 +- index.html | 2 +- index.page-vue-render.js | 2 +- team/choiwab.html | 2 +- team/choiwab.page-vue-render.js | 2 +- team/jayjay19630.html | 2 +- team/jayjay19630.page-vue-render.js | 2 +- team/rxchell.html | 2 +- team/rxchell.page-vue-render.js | 2 +- team/vangmay.html | 2 +- team/vangmay.page-vue-render.js | 2 +- team/zaidansani.html | 2 +- team/zaidansani.page-vue-render.js | 2 +- 30 files changed, 40 insertions(+), 33 deletions(-) diff --git a/AboutUs.html b/AboutUs.html index af1937847de..4e60df32c37 100644 --- a/AboutUs.html +++ b/AboutUs.html @@ -23,7 +23,7 @@ [portfolio]

Rachel Tai

[github] [portfolio]

Jo An

[github] [email] -[portfolio]

+[portfolio]

diff --git a/AboutUs.page-vue-render.js b/AboutUs.page-vue-render.js index be75d442c95..039594a9f55 100644 --- a/AboutUs.page-vue-render.js +++ b/AboutUs.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"about-us"}},[_v("About Us"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#about-us","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We are a team based in the "),_c('a',{attrs:{"href":"http://www.comp.nus.edu.sg"}},[_v("School of Computing, National University of Singapore")]),_v(".")]),_v(" "),_c('p',[_v("You can reach us at our individual emails below!")]),_v(" "),_c('h2',{attrs:{"id":"project-team"}},[_v("Project team"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-team","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"vangmay-sachan"}},[_v("Vangmay Sachan"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#vangmay-sachan","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/vangmay.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/vangmay"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/vangmay.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Quality Assurance")]),_v(" "),_c('li',[_v("Responsibilities: Logic")])]),_v(" "),_c('h3',{attrs:{"id":"muhammad-zaidan-bin-sani"}},[_v("Muhammad ZAIDAN bin Sani"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#muhammad-zaidan-bin-sani","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/zaidansani.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/zaidansani"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"mailto:zaidan@u.nus.edu"}},[_v("email")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/zaidansani.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Team Lead, Developer, Integration")]),_v(" "),_c('li',[_v("Responsibilities: Model")])]),_v(" "),_c('h3',{attrs:{"id":"jae-choi"}},[_v("Jae Choi"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#jae-choi","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/choiwab.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/choiwab"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/choiwab.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Code quality")]),_v(" "),_c('li',[_v("Responsibilities: Storage")])]),_v(" "),_c('h3',{attrs:{"id":"rachel-tai"}},[_v("Rachel Tai"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#rachel-tai","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/rxchell.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/rxchell"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/rxchell.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Documentation")]),_v(" "),_c('li',[_v("Responsibilities: Commons")])]),_v(" "),_c('h3',{attrs:{"id":"jo-an"}},[_v("Jo An"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#jo-an","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/jayjay19630.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/jayjay19630"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"mailto:jo.an@u.nus.edu"}},[_v("email")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/jayjay19630.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Deliverables and Deadlines, Scheduling and Tracking")]),_v(" "),_c('li',[_v("Responsibilities: UI")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index 08008364123..f907c224278 100644 --- a/Configuration.html +++ b/Configuration.html @@ -16,7 +16,7 @@ Search

Configuration guide

Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: config.json).

+
  • About Us

    • Configuration guide

    Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: config.json).

    diff --git a/Configuration.page-vue-render.js b/Configuration.page-vue-render.js index 4b2872afc46..306a1d11c57 100644 --- a/Configuration.page-vue-render.js +++ b/Configuration.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"configuration-guide"}},[_v("Configuration guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#configuration-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(").")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index d181f37d247..2c42bd644f0 100644 --- a/DevOps.html +++ b/DevOps.html @@ -18,7 +18,7 @@
  • About Us

    • DevOps guide

    Build automation

    This project uses Gradle for build automation and dependency management. You are recommended to read this Gradle Tutorial from the se-edu/guides.

    Given below are how to use Gradle for some important project tasks.

    Continuous integration (CI)

    This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the .github/workflows folder). No further setting up required.

    Code coverage

    As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your tests.

    However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to check the code coverage levels periodically and take corrective actions if the coverage level falls below desired levels.

    To enable Codecov for forks of this project, follow the steps given in this se-edu guide.

    Repository-wide checks

    In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.

    These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:

    ./config/travis/run-checks.sh

    Any warnings or errors will be printed out to the console.

    If adding new checks:

    Making a release

    Here are the steps to create a new release.

    1. Update the version number in MainApp.java.
    2. Generate a fat JAR file using Gradle (i.e., gradlew shadowJar).
    3. Tag the repo with the version number. e.g. v0.1
    4. Create a new release using GitHub. Upload the JAR file you created.
    +e.g. ./gradlew shadowJar.

  • run: Builds and runs the application.
    runShadow: Builds the application as a fat JAR, and then runs it.

  • checkstyleMain: Runs the code style check for the main code base.
    checkstyleTest: Runs the code style check for the test code base.

  • test: Runs all tests.

    • Continuous integration (CI)

    This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the .github/workflows folder). No further setting up required.

    Code coverage

    As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your tests.

    However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to check the code coverage levels periodically and take corrective actions if the coverage level falls below desired levels.

    To enable Codecov for forks of this project, follow the steps given in this se-edu guide.

    Repository-wide checks

    In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.

    These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:

    ./config/travis/run-checks.sh

    Any warnings or errors will be printed out to the console.

    If adding new checks:

    Making a release

    Here are the steps to create a new release.

    1. Update the version number in MainApp.java.
    2. Generate a fat JAR file using Gradle (i.e., gradlew shadowJar).
    3. Tag the repo with the version number. e.g. v0.1
    4. Create a new release using GitHub. Upload the JAR file you created.
    diff --git a/DevOps.page-vue-render.js b/DevOps.page-vue-render.js index 9aaba752a06..aa126b7e6b7 100644 --- a/DevOps.page-vue-render.js +++ b/DevOps.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"devops-guide"}},[_v("DevOps guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#devops-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('h2',{attrs:{"id":"build-automation"}},[_v("Build automation"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#build-automation","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This project uses Gradle for "),_c('strong',[_v("build automation and dependency management")]),_v(". "),_c('strong',[_v("You are recommended to read "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/gradle.html"}},[_v("this Gradle Tutorial from the se-edu/guides")])]),_v(".")]),_v(" "),_c('p',[_v("Given below are how to use Gradle for some important project tasks.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clean")])]),_v(": Deletes the files created during the previous build tasks (e.g. files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("build")]),_v(" folder)."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew clean")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("shadowJar")])]),_v(": Uses the ShadowJar plugin to creat a fat JAR file in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("build/lib")]),_v(" folder, "),_c('em',[_v("if the current file is outdated")]),_v("."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew shadowJar")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run")])]),_v(": Builds and runs the application."),_c('br'),_v(" "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("runShadow")])]),_v(": Builds the application as a fat JAR, and then runs it.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("checkstyleMain")])]),_v(": Runs the code style check for the main code base."),_c('br'),_v(" "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("checkstyleTest")])]),_v(": Runs the code style check for the test code base.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")])]),_v(": Runs all tests.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew test")]),_v(" — Runs all tests")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew clean test")]),_v(" — Cleans the project and runs tests")])])])]),_v(" "),_c('hr'),_v(" "),_c('h2',{attrs:{"id":"continuous-integration-ci"}},[_v("Continuous integration (CI)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#continuous-integration-ci","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows")]),_v(" folder). No further setting up required.")]),_v(" "),_c('h3',{attrs:{"id":"code-coverage"}},[_v("Code coverage"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#code-coverage","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your tests.")]),_v(" "),_c('p',[_v("However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to check the code coverage levels periodically and take corrective actions if the coverage level falls below desired levels.")]),_v(" "),_c('p',[_v("To enable Codecov for forks of this project, follow the steps given in "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/codecov.html"}},[_v("this se-edu guide")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"repository-wide-checks"}},[_v("Repository-wide checks"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repository-wide-checks","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.")]),_v(" "),_c('p',[_v("These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config/travis/run-checks.sh")])]),_v(" "),_c('p',[_v("Any warnings or errors will be printed out to the console.")]),_v(" "),_c('p',[_c('strong',[_v("If adding new checks:")])]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("Checks are implemented as executable "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("check-*")]),_v(" scripts within the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github")]),_v(" directory. The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run-checks.sh")]),_v(" script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.")])]),_v(" "),_c('li',[_c('p',[_v("Check scripts should print out errors in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SEVERITY:FILENAME:LINE: MESSAGE")])]),_v(" "),_c('ul',[_c('li',[_v("SEVERITY is either ERROR or WARN.")]),_v(" "),_c('li',[_v("FILENAME is the path to the file relative to the current directory.")]),_v(" "),_c('li',[_v("LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.")])])]),_v(" "),_c('li',[_c('p',[_v("Check scripts must exit with a non-zero exit code if any errors occur.")])])]),_v(" "),_c('hr'),_v(" "),_c('h2',{attrs:{"id":"making-a-release"}},[_v("Making a release"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#making-a-release","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Here are the steps to create a new release.")]),_v(" "),_c('ol',[_c('li',[_v("Update the version number in "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainApp.java")])]),_v(".")]),_v(" "),_c('li',[_v("Generate a fat JAR file using Gradle (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gradlew shadowJar")]),_v(").")]),_v(" "),_c('li',[_v("Tag the repo with the version number. e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v0.1")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://help.github.com/articles/creating-releases/"}},[_v("Create a new release using GitHub")]),_v(". Upload the JAR file you created.")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index ee8e2f08493..1806e0173d8 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -125,11 +125,12 @@
    1. Prerequisites: At least one person in DocTrack, for proper testing.
    2. Test case: clear appt
    3. Expected: The list is updated to show no appointment.

    Saving data

    1. Dealing with missing/corrupted data files
      1. Test case: missing data file
        1. Navigate to ../data and delete the .json files.
        2. Run the application
        3. Expected: The application should still run, with sample data shown in the list.
      2. Test case: corrupted data file -
        1. Navigate to ../data and edit the .json file, adding a random / at the end.
        2. Run the application
        3. Expected: The application should still run, with sample data shown in the list.


    Appendix: Planned enhancements

    Team size: 5

    2. Modify date parsing to check for leap years

    Achievements

    Our project successfully expanded AB3’s functionality, enabling the application to manage patients and appointments. Despite the challenges, our final solution provides a user-friendly interface and coherent command structure. Additionally, the design allows for potential future expansion to include other entity types without extensive restructuring, making the system both flexible and scalable.


    diff --git a/DeveloperGuide.page-vue-render.js b/DeveloperGuide.page-vue-render.js index bb4fc8ee672..700e9da4991 100644 --- a/DeveloperGuide.page-vue-render.js +++ b/DeveloperGuide.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/tp/index.html","title":"Home"}},[_v("DocTrack")])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/index.html"}},[_v("Home")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/se-edu/addressbook-level3","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Site Map")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/index.html"}},[_v("Home")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureDiagram.png","width":"280"}}),_v(" "),_m(9),_v(" "),_c('p',[_v("Given below is a quick overview of main components and how they interact with each other.")]),_v(" "),_c('br'),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_c('br'),_v(" "),_c('p',[_v("The bulk of the app's work is done by the following four components:")]),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_c('br'),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureSequenceDiagram.png","width":"574"}}),_v(" "),_c('p',[_v("Each of the four main components (also shown in the diagram above),")]),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ComponentManagers.png","width":"300"}}),_v(" "),_m(19),_v(" "),_c('p',[_v("The sections below give more details of each component.")]),_v(" "),_c('br'),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/UiClassDiagram.png","alt":"Structure of the UI Component"}}),_v(" "),_m(22),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_c('br'),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_m(28),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/LogicClassDiagram.png","width":"550"}}),_v(" "),_m(29),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/DeleteSequenceDiagram.png","alt":"Interactions Inside the Logic Component for the `delete 1` Command"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" The lifeline for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommandParser")]),_v(" should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.")])]),_v(" "),_m(30),_v(" "),_m(31),_v(" "),_m(32),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ParserClasses.png","width":"600"}}),_v(" "),_c('p',[_v("How the parsing works:")]),_v(" "),_m(33),_v(" "),_c('br'),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ModelClassDiagram.png","width":"750"}}),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" An alternative (arguably, a more OOP) model is given below. It has a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" list (the\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UniqueTagList")]),_v(") in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(", which "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" references. This allows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(" to only require one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" object per unique tag, instead of each "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" needing their own "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" objects. Similarly, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(" objects are shown as such too."),_c('br')]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/BetterModelClassDiagram.png","width":"750"}})],1),_v(" "),_c('br'),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StorageClassDiagram.png","width":"650"}}),_v(" "),_m(40),_v(" "),_c('br'),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(43),_v(" "),_c('p',[_v("The activity diagram shows the general sequence of steps when a user interacts with DocTrack.")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/OverallFlowActivityDiagram.png","width":"700"}}),_v(" "),_m(44),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_m(47),_v(" "),_c('p',[_v("The sequence diagram shows how an entity command is executed:")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/EntityCommandSequenceDiagram.png","alt":"EntityCommandSequenceDiagram"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" There are two entities, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("The entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("Similarly, the entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("This applies for the other commands as well.")])])]),_v(" "),_m(48),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_c('br'),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_c('br'),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_c('br'),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('br'),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_c('br'),_v(" "),_m(66),_v(" "),_m(67),_v(" "),_c('br'),_v(" "),_m(68),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_c('br'),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_c('br'),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('br'),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_m(78),_v(" "),_c('br'),_v(" "),_m(79),_v(" "),_m(80),_v(" "),_c('br'),_v(" "),_m(81),_v(" "),_m(82),_v(" "),_c('box',{attrs:{"type":"tip","theme":"success","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v("\nTo add a new predicate, navigate the corresponding entity folder in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model")]),_v(" package. There, you can create a new class that implements "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Predicate")]),_v(". Ensure that this method has a test method which defines the specific condition for a predicate.")])]),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(83),_v(" "),_m(84),_v(" "),_m(85),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/GeneralCommandsSequenceDiagram.png","width":"600"}}),_v(" "),_m(86),_v(" "),_m(87),_v(" "),_m(88),_v(" "),_m(89),_v(" "),_m(90),_v(" "),_c('br'),_v(" "),_m(91),_v(" "),_m(92),_v(" "),_c('br'),_v(" "),_m(93),_v(" "),_m(94),_v(" "),_m(95),_v(" "),_m(96),_v(" "),_m(97),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(98),_v(" "),_m(99),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(100),_v(" "),_m(101),_v(" "),_m(102),_v(" "),_m(103),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v("\nFor "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(", the fields "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v(" are optional. Hence, if "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v("\nis not specified, it would be represented as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"null\"")]),_v(", in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("appointmentbook.json")]),_v(" file.")])]),_v(" "),_c('br'),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_c('br'),_v(" "),_m(106),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_c('br'),_v(" "),_m(109),_v(" "),_m(110),_v(" "),_c('br'),_v(" "),_m(111),_v(" "),_m(112),_v(" "),_c('br'),_v(" "),_m(113),_v(" "),_m(114),_v(" "),_m(115),_v(" "),_c('br'),_v(" "),_m(116),_v(" "),_m(117),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(118),_v(" "),_m(119),_v(" "),_m(120),_v(" "),_m(121),_v(" "),_m(122),_v(" "),_m(123),_v(" "),_c('br'),_v(" "),_m(124),_v(" "),_m(125),_v(" "),_m(126),_c('br'),_v(" "),_m(127),_v(" "),_c('p',[_v("For all use cases below, unless specified otherwise,")]),_v(" "),_m(128),_v(" "),_c('br'),_v(" "),_m(129),_v(" "),_m(130),_v(" "),_m(131),_v(" "),_m(132),_v(" "),_m(133),_v(" "),_c('br'),_v(" "),_m(134),_v(" "),_m(135),_v(" "),_m(136),_v(" "),_m(137),_v(" "),_m(138),_v(" "),_c('br'),_v(" "),_m(139),_v(" "),_m(140),_v(" "),_m(141),_v(" "),_m(142),_v(" "),_m(143),_v(" "),_c('br'),_v(" "),_m(144),_v(" "),_m(145),_v(" "),_m(146),_v(" "),_m(147),_v(" "),_m(148),_v(" "),_c('br'),_v(" "),_m(149),_v(" "),_m(150),_v(" "),_m(151),_v(" "),_m(152),_v(" "),_m(153),_v(" "),_c('br'),_v(" "),_m(154),_v(" "),_m(155),_v(" "),_m(156),_v(" "),_c('br'),_v(" "),_m(157),_v(" "),_m(158),_v(" "),_m(159),_v(" "),_m(160),_v(" "),_m(161),_v(" "),_c('br'),_v(" "),_m(162),_v(" "),_m(163),_v(" "),_m(164),_v(" "),_m(165),_v(" "),_m(166),_v(" "),_c('br'),_v(" "),_m(167),_v(" "),_m(168),_v(" "),_m(169),_v(" "),_m(170),_v(" "),_m(171),_v(" "),_c('br'),_v(" "),_m(172),_v(" "),_m(173),_v(" "),_m(174),_v(" "),_m(175),_v(" "),_m(176),_v(" "),_c('br'),_v(" "),_m(177),_v(" "),_m(178),_v(" "),_m(179),_v(" "),_m(180),_v(" "),_m(181),_v(" "),_c('br'),_v(" "),_m(182),_v(" "),_m(183),_v(" "),_m(184),_v(" "),_c('br'),_v(" "),_m(185),_v(" "),_m(186),_v(" "),_c('br'),_v(" "),_m(187),_v(" "),_m(188),_v(" "),_m(189),_v(" "),_m(190),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(191),_v(" "),_c('p',[_v("Given below are instructions to test the app manually.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" These instructions only provide a starting point for testers to work on;\ntesters are expected to do more "),_c('em',[_v("exploratory")]),_v(" testing.")])]),_v(" "),_c('br'),_v(" "),_m(192),_v(" "),_m(193),_v(" "),_m(194),_v(" "),_m(195),_v(" "),_m(196),_v(" "),_m(197),_v(" "),_m(198),_v(" "),_m(199),_v(" "),_m(200),_v(" "),_m(201),_v(" "),_m(202),_v(" "),_m(203),_v(" "),_m(204),_v(" "),_m(205),_v(" "),_m(206),_v(" "),_m(207),_v(" "),_m(208),_v(" "),_m(209),_v(" "),_m(210),_v(" "),_m(211),_v(" "),_m(212),_v(" "),_m(213),_v(" "),_m(214),_v(" "),_m(215),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(216),_v(" "),_c('p',[_v("Team size: 5")]),_v(" "),_m(217),_v(" "),_m(218),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(219),_v(" "),_m(220),_v(" "),_c('p',[_v("Our project presented a higher level of complexity compared to AB3. Our project involved handling multiple entity types, mainly persons and appointments, whereas AB3 manages only a single entity. This increased the requirements for command processing as each entity type has additional attributes and methods.")]),_v(" "),_m(221),_v(" "),_m(222),_v(" "),_m(223),_v(" "),_c('p',[_v("Our project involved substantial effort in several key areas:")]),_v(" "),_m(224),_v(" "),_m(225),_v(" "),_c('p',[_v("Our project successfully expanded AB3’s functionality, enabling the application to manage patients and appointments. Despite the challenges, our final solution provides a user-friendly interface and coherent command structure. Additionally, the design allows for potential future expansion to include other entity types without extensive restructuring, making the system both flexible and scalable.")]),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#doctrack-developer-guide"}},[_v("DocTrack Developer Guide‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#acknowledgements"}},[_v("Acknowledgements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#setting-up-getting-started"}},[_v("Setting up, getting started‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#design"}},[_v("Design‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#architecture"}},[_v("Architecture‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#ui-component"}},[_v("UI component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#logic-component"}},[_v("Logic component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#model-component"}},[_v("Model component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#storage-component"}},[_v("Storage component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#common-classes"}},[_v("Common classes‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#flow"}},[_v("Flow‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-entity-command-features"}},[_v("Implementation of entity command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-design-considerations"}},[_v("General Design Considerations‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-specific-design-considerations"}},[_v("Command-Specific Design Considerations‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-general-command-features"}},[_v("Implementation of general command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exit-feature"}},[_v("Exit feature‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#help-feature"}},[_v("Help feature‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-miscellaneous-design-considerations"}},[_v("Appendix: Miscellaneous Design Considerations‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#data-storage-and-files"}},[_v("Data storage and files‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#parsing"}},[_v("Parsing‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-interface"}},[_v("User Interface‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-requirements"}},[_v("Appendix: Requirements‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#product-scope"}},[_v("Product scope‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-stories"}},[_v("User stories‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#use-cases"}},[_v("Use cases‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#non-functional-requirements"}},[_v("Non-Functional Requirements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#glossary"}},[_v("Glossary‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#launch-and-shutdown"}},[_v("Launch and shutdown‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-a-person"}},[_v("Adding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person"}},[_v("Deleting a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-a-person"}},[_v("Editing a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-a-person"}},[_v("Finding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-an-appointment"}},[_v("Adding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-an-appointment"}},[_v("Deleting an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-an-appointment"}},[_v("Editing an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-an-appointment"}},[_v("Finding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list-2"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#saving-data"}},[_v("Saving data‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-planned-enhancements"}},[_v("Appendix: Planned enhancements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-effort"}},[_v("Appendix: Effort‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(226)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/tp/index.html","title":"Home"}},[_v("DocTrack")])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/index.html"}},[_v("Home")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/se-edu/addressbook-level3","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Site Map")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/index.html"}},[_v("Home")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureDiagram.png","width":"280"}}),_v(" "),_m(9),_v(" "),_c('p',[_v("Given below is a quick overview of main components and how they interact with each other.")]),_v(" "),_c('br'),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_c('br'),_v(" "),_c('p',[_v("The bulk of the app's work is done by the following four components:")]),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_c('br'),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureSequenceDiagram.png","width":"574"}}),_v(" "),_c('p',[_v("Each of the four main components (also shown in the diagram above),")]),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ComponentManagers.png","width":"300"}}),_v(" "),_m(19),_v(" "),_c('p',[_v("The sections below give more details of each component.")]),_v(" "),_c('br'),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/UiClassDiagram.png","alt":"Structure of the UI Component"}}),_v(" "),_m(22),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_c('br'),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_m(28),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/LogicClassDiagram.png","width":"550"}}),_v(" "),_m(29),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/DeleteSequenceDiagram.png","alt":"Interactions Inside the Logic Component for the `delete 1` Command"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" The lifeline for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommandParser")]),_v(" should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.")])]),_v(" "),_m(30),_v(" "),_m(31),_v(" "),_m(32),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ParserClasses.png","width":"600"}}),_v(" "),_c('p',[_v("How the parsing works:")]),_v(" "),_m(33),_v(" "),_c('br'),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ModelClassDiagram.png","width":"750"}}),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" An alternative (arguably, a more OOP) model is given below. It has a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" list (the\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UniqueTagList")]),_v(") in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(", which "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" references. This allows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(" to only require one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" object per unique tag, instead of each "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" needing their own "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" objects. Similarly, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(" objects are shown as such too."),_c('br')]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/BetterModelClassDiagram.png","width":"750"}})],1),_v(" "),_c('br'),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StorageClassDiagram.png","width":"650"}}),_v(" "),_m(40),_v(" "),_c('br'),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(43),_v(" "),_c('p',[_v("The activity diagram shows the general sequence of steps when a user interacts with DocTrack.")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/OverallFlowActivityDiagram.png","width":"700"}}),_v(" "),_m(44),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_m(47),_v(" "),_c('p',[_v("The sequence diagram shows how an entity command is executed:")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/EntityCommandSequenceDiagram.png","alt":"EntityCommandSequenceDiagram"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" There are two entities, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("The entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("Similarly, the entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("This applies for the other commands as well.")])])]),_v(" "),_m(48),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_c('br'),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_c('br'),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_c('br'),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('br'),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_c('br'),_v(" "),_m(66),_v(" "),_m(67),_v(" "),_c('br'),_v(" "),_m(68),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_c('br'),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_c('br'),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('br'),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_m(78),_v(" "),_c('br'),_v(" "),_m(79),_v(" "),_m(80),_v(" "),_c('br'),_v(" "),_m(81),_v(" "),_m(82),_v(" "),_c('box',{attrs:{"type":"tip","theme":"success","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v("\nTo add a new predicate, navigate the corresponding entity folder in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model")]),_v(" package. There, you can create a new class that implements "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Predicate")]),_v(". Ensure that this method has a test method which defines the specific condition for a predicate.")])]),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(83),_v(" "),_m(84),_v(" "),_m(85),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/GeneralCommandsSequenceDiagram.png","width":"600"}}),_v(" "),_m(86),_v(" "),_m(87),_v(" "),_m(88),_v(" "),_m(89),_v(" "),_m(90),_v(" "),_c('br'),_v(" "),_m(91),_v(" "),_m(92),_v(" "),_c('br'),_v(" "),_m(93),_v(" "),_m(94),_v(" "),_m(95),_v(" "),_m(96),_v(" "),_m(97),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(98),_v(" "),_m(99),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(100),_v(" "),_m(101),_v(" "),_m(102),_v(" "),_m(103),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v("\nFor "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(", the fields "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v(" are optional. Hence, if "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v("\nis not specified, it would be represented as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"null\"")]),_v(", in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("appointmentbook.json")]),_v(" file.")])]),_v(" "),_c('br'),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_c('br'),_v(" "),_m(106),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_c('br'),_v(" "),_m(109),_v(" "),_m(110),_v(" "),_c('br'),_v(" "),_m(111),_v(" "),_m(112),_v(" "),_c('br'),_v(" "),_m(113),_v(" "),_m(114),_v(" "),_m(115),_v(" "),_c('br'),_v(" "),_m(116),_v(" "),_m(117),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(118),_v(" "),_m(119),_v(" "),_m(120),_v(" "),_m(121),_v(" "),_m(122),_v(" "),_m(123),_v(" "),_c('br'),_v(" "),_m(124),_v(" "),_m(125),_v(" "),_m(126),_c('br'),_v(" "),_m(127),_v(" "),_c('p',[_v("For all use cases below, unless specified otherwise,")]),_v(" "),_m(128),_v(" "),_c('br'),_v(" "),_m(129),_v(" "),_m(130),_v(" "),_m(131),_v(" "),_m(132),_v(" "),_m(133),_v(" "),_c('br'),_v(" "),_m(134),_v(" "),_m(135),_v(" "),_m(136),_v(" "),_m(137),_v(" "),_m(138),_v(" "),_c('br'),_v(" "),_m(139),_v(" "),_m(140),_v(" "),_m(141),_v(" "),_m(142),_v(" "),_m(143),_v(" "),_c('br'),_v(" "),_m(144),_v(" "),_m(145),_v(" "),_m(146),_v(" "),_m(147),_v(" "),_m(148),_v(" "),_c('br'),_v(" "),_m(149),_v(" "),_m(150),_v(" "),_m(151),_v(" "),_m(152),_v(" "),_m(153),_v(" "),_c('br'),_v(" "),_m(154),_v(" "),_m(155),_v(" "),_m(156),_v(" "),_c('br'),_v(" "),_m(157),_v(" "),_m(158),_v(" "),_m(159),_v(" "),_m(160),_v(" "),_m(161),_v(" "),_c('br'),_v(" "),_m(162),_v(" "),_m(163),_v(" "),_m(164),_v(" "),_m(165),_v(" "),_m(166),_v(" "),_c('br'),_v(" "),_m(167),_v(" "),_m(168),_v(" "),_m(169),_v(" "),_m(170),_v(" "),_m(171),_v(" "),_c('br'),_v(" "),_m(172),_v(" "),_m(173),_v(" "),_m(174),_v(" "),_m(175),_v(" "),_m(176),_v(" "),_c('br'),_v(" "),_m(177),_v(" "),_m(178),_v(" "),_m(179),_v(" "),_m(180),_v(" "),_m(181),_v(" "),_c('br'),_v(" "),_m(182),_v(" "),_m(183),_v(" "),_m(184),_v(" "),_c('br'),_v(" "),_m(185),_v(" "),_m(186),_v(" "),_c('br'),_v(" "),_m(187),_v(" "),_m(188),_v(" "),_m(189),_v(" "),_m(190),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(191),_v(" "),_c('p',[_v("Given below are instructions to test the app manually.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" These instructions only provide a starting point for testers to work on;\ntesters are expected to do more "),_c('em',[_v("exploratory")]),_v(" testing.")])]),_v(" "),_c('br'),_v(" "),_m(192),_v(" "),_m(193),_v(" "),_m(194),_v(" "),_m(195),_v(" "),_m(196),_v(" "),_m(197),_v(" "),_m(198),_v(" "),_m(199),_v(" "),_m(200),_v(" "),_m(201),_v(" "),_m(202),_v(" "),_m(203),_v(" "),_m(204),_v(" "),_m(205),_v(" "),_m(206),_v(" "),_m(207),_v(" "),_m(208),_v(" "),_m(209),_v(" "),_m(210),_v(" "),_m(211),_v(" "),_m(212),_v(" "),_m(213),_v(" "),_m(214),_v(" "),_m(215),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(216),_v(" "),_c('p',[_v("Team size: 5")]),_v(" "),_m(217),_v(" "),_m(218),_v(" "),_m(219),_v(" "),_m(220),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(221),_v(" "),_m(222),_v(" "),_c('p',[_v("Our project presented a higher level of complexity compared to AB3. Our project involved handling multiple entity types, mainly persons and appointments, whereas AB3 manages only a single entity. This increased the requirements for command processing as each entity type has additional attributes and methods.")]),_v(" "),_m(223),_v(" "),_m(224),_v(" "),_m(225),_v(" "),_c('p',[_v("Our project involved substantial effort in several key areas:")]),_v(" "),_m(226),_v(" "),_m(227),_v(" "),_c('p',[_v("Our project successfully expanded AB3’s functionality, enabling the application to manage patients and appointments. Despite the challenges, our final solution provides a user-friendly interface and coherent command structure. Additionally, the design allows for potential future expansion to include other entity types without extensive restructuring, making the system both flexible and scalable.")]),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#doctrack-developer-guide"}},[_v("DocTrack Developer Guide‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#acknowledgements"}},[_v("Acknowledgements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#setting-up-getting-started"}},[_v("Setting up, getting started‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#design"}},[_v("Design‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#architecture"}},[_v("Architecture‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#ui-component"}},[_v("UI component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#logic-component"}},[_v("Logic component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#model-component"}},[_v("Model component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#storage-component"}},[_v("Storage component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#common-classes"}},[_v("Common classes‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#flow"}},[_v("Flow‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-entity-command-features"}},[_v("Implementation of entity command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-design-considerations"}},[_v("General Design Considerations‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-specific-design-considerations"}},[_v("Command-Specific Design Considerations‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-general-command-features"}},[_v("Implementation of general command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exit-feature"}},[_v("Exit feature‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#help-feature"}},[_v("Help feature‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-miscellaneous-design-considerations"}},[_v("Appendix: Miscellaneous Design Considerations‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#data-storage-and-files"}},[_v("Data storage and files‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#parsing"}},[_v("Parsing‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-interface"}},[_v("User Interface‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-requirements"}},[_v("Appendix: Requirements‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#product-scope"}},[_v("Product scope‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-stories"}},[_v("User stories‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#use-cases"}},[_v("Use cases‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#non-functional-requirements"}},[_v("Non-Functional Requirements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#glossary"}},[_v("Glossary‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#launch-and-shutdown"}},[_v("Launch and shutdown‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-a-person"}},[_v("Adding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person"}},[_v("Deleting a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-a-person"}},[_v("Editing a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-a-person"}},[_v("Finding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-an-appointment"}},[_v("Adding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-an-appointment"}},[_v("Deleting an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-an-appointment"}},[_v("Editing an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-an-appointment"}},[_v("Finding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list-2"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#saving-data"}},[_v("Saving data‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-planned-enhancements"}},[_v("Appendix: Planned enhancements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-effort"}},[_v("Appendix: Effort‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(228)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -656,7 +656,13 @@ with(this){return _c('ol',[_c('li',[_v("Dealing with missing/corrupted data file with(this){return _c('h2',{attrs:{"id":"appendix-planned-enhancements"}},[_c('strong',[_v("Appendix: Planned enhancements")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-planned-enhancements","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('ol',[_c('li'),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Modify date parsing to check for leap years")])])])])} +with(this){return _c('ol',[_c('li',[_c('strong',[_v("When an invalid command is entered, suggest possible valid commands.")])])])} +},function anonymous( +) { +with(this){return _c('ul',[_c('li',[_c('strong',[_v("Flaw:")]),_v(" When a user types an unknown command, the result display box shows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Unknown Command")]),_v(", which is\nnot informative.")]),_v(" "),_c('li',[_c('strong',[_v("Enhancement:")]),_v(" The result display box will suggest possible valid commands for the user to enter.")]),_v(" "),_c('li',[_c('strong',[_v("Sample Input:")]),_v(" User enters: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort")])]),_v(" "),_c('li',[_c('strong',[_v("Expected Output:")]),_v(" The result display box shows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Unknown Command. Did you mean: list, find, clear, add, edit, delete, exit, or help?")])])])} +},function anonymous( +) { +with(this){return _c('ol',{attrs:{"start":"2"}},[_c('li',[_c('strong',[_v("Modify date parsing to check for leap years")])])])} },function anonymous( ) { with(this){return _c('ul',[_c('li',[_c('strong',[_v("Flaw:")]),_v(" When a user enters February 29 for a non-leap year, the date automatically adjusts to February\n28, which may be confusing.")]),_v(" "),_c('li',[_c('strong',[_v("Enhancement:")]),_v(" Modify the date parsing logic to check for leap years.\n"),_c('ul',[_c('li',[_v("If the user enters February 29 for a non-leap year, display an error message indicating that the date is invalid.")]),_v(" "),_c('li',[_v("If the user enters February 29 for a leap year, the date is accepted.")])])]),_v(" "),_c('li',[_c('strong',[_v("Sample Input:")]),_v(" User enters "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2023-02-29")]),_v(" for an appointment date.")]),_v(" "),_c('li',[_c('strong',[_v("Expected Output:")]),_v(" The result display box shows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Invalid date: 2023 is not a leap year, so February 29 is not valid.")])])])} @@ -683,6 +689,6 @@ with(this){return _c('ul',[_c('li',[_c('strong',[_v("Design and Refactoring")]), with(this){return _c('h4',{attrs:{"id":"achievements"}},[_v("Achievements"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#achievements","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index 719e0619f26..57f758463d8 100644 --- a/Documentation.html +++ b/Documentation.html @@ -16,7 +16,7 @@ Search

    Documentation Guide

    Style guidance:

    Converting to PDF

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +
  • About Us

    • Documentation Guide

    Style guidance:

    Converting to PDF

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/Documentation.page-vue-render.js b/Documentation.page-vue-render.js index 2a399f1540d..8b6953b80b8 100644 --- a/Documentation.page-vue-render.js +++ b/Documentation.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"documentation-guide"}},[_v("Documentation Guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#documentation-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_v("We use "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_c('strong',[_v("MarkBind")])]),_v(" to manage documentation.")]),_v(" "),_c('li',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docs/")]),_v(" folder contains the source files for the documentation website.")]),_v(" "),_c('li',[_v("To learn how set it up and maintain the project website, follow the guide "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/markbind-forked-sites.html"}},[_v("[se-edu/guides] Working with Forked MarkBind sites")]),_v(" for project documentation.")])]),_v(" "),_c('p',[_c('strong',[_v("Style guidance:")])]),_v(" "),_c('ul',[_c('li',[_v("Follow the "),_c('a',{attrs:{"href":"https://developers.google.com/style"}},[_c('strong',[_c('em',[_v("Google developer documentation style guide")])])]),_v(".")]),_v(" "),_c('li',[_v("Also relevant is the "),_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/markdown.html"}},[_c('em',[_v("se-edu/guides "),_c('strong',[_v("Markdown coding standard")])])]),_v(".")])]),_v(" "),_c('p',[_c('strong',[_v("Converting to PDF")])]),_v(" "),_c('ul',[_c('li',[_v("See the guide "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/savingPdf.html"}},[_c('em',[_v("se-edu/guides "),_c('strong',[_v("Saving web documents as PDF files")])])]),_v(".")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index ba0e7b7f25a..f359141db7b 100644 --- a/Logging.html +++ b/Logging.html @@ -16,7 +16,7 @@ Search

    Logging guide

    • We are using java.util.logging package for logging.
    • The LogsCenter class is used to manage the logging levels and logging destinations.
    • The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level.
    • Log messages are output through the console and to a .log file.
    • The output logging level can be controlled using the logLevel setting in the configuration file (See the Configuration guide section).
    • When choosing a level for a log message, follow the conventions given in [se-edu/guides] Java: Logging conventions.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +
  • About Us

    • Logging guide

    • We are using java.util.logging package for logging.
    • The LogsCenter class is used to manage the logging levels and logging destinations.
    • The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level.
    • Log messages are output through the console and to a .log file.
    • The output logging level can be controlled using the logLevel setting in the configuration file (See the Configuration guide section).
    • When choosing a level for a log message, follow the conventions given in [se-edu/guides] Java: Logging conventions.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/Logging.page-vue-render.js b/Logging.page-vue-render.js index 5aaeda7a492..61599429849 100644 --- a/Logging.page-vue-render.js +++ b/Logging.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"logging-guide"}},[_v("Logging guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#logging-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_v("We are using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java.util.logging")]),_v(" package for logging.")]),_v(" "),_c('li',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LogsCenter")]),_v(" class is used to manage the logging levels and logging destinations.")]),_v(" "),_c('li',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Logger")]),_v(" for a class can be obtained using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LogsCenter.getLogger(Class)")]),_v(" which will log messages according to the specified logging level.")]),_v(" "),_c('li',[_v("Log messages are output through the console and to a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".log")]),_v(" file.")]),_v(" "),_c('li',[_v("The output logging level can be controlled using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("logLevel")]),_v(" setting in the configuration file (See the "),_c('a',{attrs:{"href":"/tp/Configuration.html"}},[_v("Configuration guide")]),_v(" section).")]),_v(" "),_c('li',[_c('strong',[_v("When choosing a level for a log message")]),_v(", follow the conventions given in "),_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/java/logging.html"}},[_c('em',[_v("[se-edu/guides] Java: Logging conventions")])]),_v(".")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index 4c40703fd9e..f33654c6cf6 100644 --- a/SettingUp.html +++ b/SettingUp.html @@ -22,7 +22,7 @@
  • Verify the setup:
    1. Run the seedu.address.Main and try a few commands.
    2. Run the tests to ensure they all pass.

    • Before writing code

    1. Configure the coding style

      If using IDEA, follow the guide [se-edu/guides] IDEA: Configuring the code style to set up IDEA's coding style to match ours.

      Tip: Optionally, you can follow the guide [se-edu/guides] Using Checkstyle to find how to use the CheckStyle within IDEA e.g., to report problems as you write code.

    2. Set up CI

      This project comes with a GitHub Actions config files (in .github/workflows folder). When GitHub detects those files, it will run the CI for your project automatically at each push to the master branch or to any PR. No set up required.

    3. Learn the design

      When you are ready to start coding, we recommend that you get some sense of the overall design by reading about AddressBook’s architecture.

    4. Do the tutorials -These tutorials will help you get acquainted with the codebase.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +These tutorials will help you get acquainted with the codebase.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/SettingUp.page-vue-render.js b/SettingUp.page-vue-render.js index fa30f31ee80..34ceb5ec997 100644 --- a/SettingUp.page-vue-render.js +++ b/SettingUp.page-vue-render.js @@ -41,6 +41,6 @@ with(this){return _c('li',[_c('p',[_c('strong',[_v("Learn the design")])]),_v(" with(this){return _c('li',[_c('p',[_c('strong',[_v("Do the tutorials")]),_v("\nThese tutorials will help you get acquainted with the codebase.")]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a new command")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing fields")])])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index 44643b8d317..ac988521e1c 100644 --- a/Testing.html +++ b/Testing.html @@ -20,7 +20,7 @@ test class, or a test and choose Run 'ABC'
  • Method 2: Using Gradle
    • Open a console and run the command gradlew clean test (Mac/Linux: ./gradlew clean test)

    • Link: Read this Gradle Tutorial from the se-edu/guides to learn more about using Gradle.

    Types of tests

    This project has three types of tests:

    1. Unit tests targeting the lowest level methods/classes.
      e.g. seedu.address.commons.StringUtilTest
    2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.address.storage.StorageManagerTest
    3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
      -e.g. seedu.address.logic.LogicManagerTest
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +e.g. seedu.address.logic.LogicManagerTest
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/Testing.page-vue-render.js b/Testing.page-vue-render.js index 4a573cf2652..047af7e5046 100644 --- a/Testing.page-vue-render.js +++ b/Testing.page-vue-render.js @@ -20,6 +20,6 @@ with(this){return _c('h2',{attrs:{"id":"types-of-tests"}},[_v("Types of tests"), with(this){return _c('ol',[_c('li',[_c('em',[_v("Unit tests")]),_v(" targeting the lowest level methods/classes."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seedu.address.commons.StringUtilTest")])]),_v(" "),_c('li',[_c('em',[_v("Integration tests")]),_v(" that are checking the integration of multiple code units (those code units are assumed to be working)."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seedu.address.storage.StorageManagerTest")])]),_v(" "),_c('li',[_v("Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seedu.address.logic.LogicManagerTest")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index 6459bfca2e5..9d1d58fee8c 100644 --- a/UserGuide.html +++ b/UserGuide.html @@ -116,7 +116,7 @@ folder.
  • Replace these empty files with the addressbook.json and appointmentbook.json files you saved from your previous computer.

    • Q: Can I access DocTrack without internet connection?
    A: Yes, you can run DocTrack without an internet connection.


    Q: How do I back up my data?
    A: Since the data is saved in the addressbook.json and appointmentbook.json files in the data folder, you can copy these files to another location as a backup.


    Q: How many patients and appointments does DocTrack support?
    A: DocTrack technically supports up to 4 billion total historical patients and appointments. However, depending on your system, it might lag with larger numbers of patients and appointments. -We recommend that you do not exceed 10,000 total patients and appointments.




    Known issues

    1. When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the preferences.json file created by the application before running the application again.

    1. If you minimize the Help Window and then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

    1. On MacOS systems, the bold fonts may appear slightly clipped.

    1. Editing the name in the edit person command will not reflect the name change in the appointments until a reload of the application.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +We recommend that you do not exceed 10,000 total patients and appointments.




    Known issues

    1. When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the preferences.json file created by the application before running the application again.

    1. If you minimize the Help Window and then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

    1. On MacOS systems, the bold fonts may appear slightly clipped.

    1. Editing the name in the edit person command will not reflect the name change in the appointments until a reload of the application.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/UserGuide.page-vue-render.js b/UserGuide.page-vue-render.js index bcd1507c581..f0f410317e3 100644 --- a/UserGuide.page-vue-render.js +++ b/UserGuide.page-vue-render.js @@ -332,6 +332,6 @@ with(this){return _c('ol',{attrs:{"start":"3"}},[_c('li',[_v("On "),_c('strong', with(this){return _c('ol',{attrs:{"start":"4"}},[_c('li',[_v("Editing the name in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person")]),_v(" command will not reflect the name change in the appointments until a reload of the application.")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index b9221161fa1..c72d3a83f27 100644 --- a/index.html +++ b/index.html @@ -19,7 +19,7 @@
  • About Us

    • DocTrack

    CI Status Codecov

    Ui

    DocTrack is a desktop application for general practitioners (GPs) to quickly access patient contact details, appointments, and treatment records. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +place to start.

    Acknowledgements

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/index.page-vue-render.js b/index.page-vue-render.js index c3ae62b9272..ef6efa9c3a4 100644 --- a/index.page-vue-render.js +++ b/index.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"doctrack"}},[_v("DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W10-2/tp/actions"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://github.com/AY2425S1-CS2103T-W10-2/tp/workflows/Java%20CI/badge.svg","alt":"CI Status"}})]),_v(" "),_c('a',{attrs:{"href":"https://codecov.io/gh/AY2425S1-CS2103T-W10-2/tp"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://codecov.io/gh/AY2425S1-CS2103T-W10-2/tp/graph/badge.svg?token=134QRO3UI3","alt":"Codecov"}})])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/tp/images/Ui.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/Ui.png","alt":"Ui"}})])]),_v(" "),_c('p',[_c('strong',[_v("DocTrack is a desktop application for general practitioners (GPs) to quickly access patient contact\ndetails, appointments, and treatment records.")]),_v(" While it has a GUI, most of the user\ninteractions happen using a CLI (Command Line Interface).")]),_v(" "),_c('ul',[_c('li',[_v("If you are interested in using DocTrack, head over to the "),_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_c('em',[_v("Quick Start")]),_v(" section of the "),_c('strong',[_v("User Guide")])]),_v(".")]),_v(" "),_c('li',[_v("If you are interested about developing DocTrack, the "),_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_c('strong',[_v("Developer Guide")])]),_v(" is a good\nplace to start.")])]),_v(" "),_c('p',[_c('strong',[_v("Acknowledgements")])]),_v(" "),_c('ul',[_c('li',[_v("Libraries used: "),_c('a',{attrs:{"href":"https://openjfx.io/"}},[_v("JavaFX")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/FasterXML/jackson"}},[_v("Jackson")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/junit-team/junit5"}},[_v("JUnit5")])])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/choiwab.html b/team/choiwab.html index c337924f21b..50b9cfc8be8 100644 --- a/team/choiwab.html +++ b/team/choiwab.html @@ -16,7 +16,7 @@ Search

    Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Given below are my contributions to the project.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +
  • About Us

    • Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Given below are my contributions to the project.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/team/choiwab.page-vue-render.js b/team/choiwab.page-vue-render.js index bf00de98529..2a9336c022d 100644 --- a/team/choiwab.page-vue-render.js +++ b/team/choiwab.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Given below are my contributions to the project.")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/jayjay19630.html b/team/jayjay19630.html index 7eebaaa6df9..5d63ea04771 100644 --- a/team/jayjay19630.html +++ b/team/jayjay19630.html @@ -16,7 +16,7 @@ Search

    Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Given below are my contributions to the project.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +
  • About Us

    • Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Given below are my contributions to the project.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/team/jayjay19630.page-vue-render.js b/team/jayjay19630.page-vue-render.js index bf00de98529..2a9336c022d 100644 --- a/team/jayjay19630.page-vue-render.js +++ b/team/jayjay19630.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Given below are my contributions to the project.")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/rxchell.html b/team/rxchell.html index b47b2566d2b..529fa0755b4 100644 --- a/team/rxchell.html +++ b/team/rxchell.html @@ -16,7 +16,7 @@ Search

    Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Given below are my contributions to the project.

    • Refactored abstraction for ListCommand to support new command format
    • Implemented the DeleteAppointmentCommand
    • Added a Status attribute in the Person class
    • Modified the Sickness and Medicine attributes to be optional in the Appointment class
    • Updated the FindPersonCommand to search for a person by name
    • Added tests for the above changes
    • Created tests for AppointmentBookStorage
    • Updated the format of the User Guide and Developer Guide to ensure consistency
    • Updated the contents of the User Guide and Developer Guide to ensure accuracy
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +
  • About Us

    • Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Given below are my contributions to the project.

    • Refactored abstraction for ListCommand to support new command format
    • Implemented the DeleteAppointmentCommand
    • Added a Status attribute in the Person class
    • Modified the Sickness and Medicine attributes to be optional in the Appointment class
    • Updated the FindPersonCommand to search for a person by name
    • Added tests for the above changes
    • Created tests for AppointmentBookStorage
    • Updated the format of the User Guide and Developer Guide to ensure consistency
    • Updated the contents of the User Guide and Developer Guide to ensure accuracy
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/team/rxchell.page-vue-render.js b/team/rxchell.page-vue-render.js index 73bec122698..f4e7e2b2540 100644 --- a/team/rxchell.page-vue-render.js +++ b/team/rxchell.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_v("Refactored abstraction for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ListCommand")]),_v(" to support new command format")]),_v(" "),_c('li',[_v("Implemented the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteAppointmentCommand")])]),_v(" "),_c('li',[_v("Added a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Status")]),_v(" attribute in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" class")]),_v(" "),_c('li',[_v("Modified the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v(" attributes to be optional in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(" class")]),_v(" "),_c('li',[_v("Updated the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindPersonCommand")]),_v(" to search for a person by name")]),_v(" "),_c('li',[_v("Added tests for the above changes")]),_v(" "),_c('li',[_v("Created tests for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AppointmentBookStorage")])]),_v(" "),_c('li',[_v("Updated the format of the User Guide and Developer Guide to ensure consistency")]),_v(" "),_c('li',[_v("Updated the contents of the User Guide and Developer Guide to ensure accuracy")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/vangmay.html b/team/vangmay.html index cc34364b070..95654aa0033 100644 --- a/team/vangmay.html +++ b/team/vangmay.html @@ -16,7 +16,7 @@ Search

    Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Role:

    • Developer
    • QA Tester
    • Responsible for overseeing Logic

    Given below are my contributions to the project:

    • Refactor Find Persons Command
    • Create add appointment command
    • Create AppointmentDescriptor in the AppointmentModel
    • Created tests for Appointment book
    • Wrote test cases to increase code coverage
    • Implement changes in UI to add 2 windows
    • Update user guide
    • Update Developer guide (Find, List, Clear appt)
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +
  • About Us

    • Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Role:

    • Developer
    • QA Tester
    • Responsible for overseeing Logic

    Given below are my contributions to the project:

    • Refactor Find Persons Command
    • Create add appointment command
    • Create AppointmentDescriptor in the AppointmentModel
    • Created tests for Appointment book
    • Wrote test cases to increase code coverage
    • Implement changes in UI to add 2 windows
    • Update user guide
    • Update Developer guide (Find, List, Clear appt)
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/team/vangmay.page-vue-render.js b/team/vangmay.page-vue-render.js index 0eac4baeb89..80375994773 100644 --- a/team/vangmay.page-vue-render.js +++ b/team/vangmay.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Role:")]),_v(" "),_c('ul',[_c('li',[_v("Developer")]),_v(" "),_c('li',[_v("QA Tester")]),_v(" "),_c('li',[_v("Responsible for overseeing Logic")])]),_v(" "),_c('p',[_v("Given below are my contributions to the project:")]),_v(" "),_c('ul',[_c('li',[_v("Refactor Find Persons Command")]),_v(" "),_c('li',[_v("Create add appointment command")]),_v(" "),_c('li',[_v("Create AppointmentDescriptor in the AppointmentModel")]),_v(" "),_c('li',[_v("Created tests for Appointment book")]),_v(" "),_c('li',[_v("Wrote test cases to increase code coverage")]),_v(" "),_c('li',[_v("Implement changes in UI to add 2 windows")]),_v(" "),_c('li',[_v("Update user guide")]),_v(" "),_c('li',[_v("Update Developer guide (Find, List, Clear appt)")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/zaidansani.html b/team/zaidansani.html index 2c4e0fe965e..4beb25b58c5 100644 --- a/team/zaidansani.html +++ b/team/zaidansani.html @@ -16,7 +16,7 @@ Search

    Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Role:

    • Team Lead
    • Developer
    • Integration

    Given below are my contributions to the project:

    • Refactoring Person into PersonDescriptor to support PersonID
    • Refactoring of DeleteCommand to support new command format
    • Refactoring of ClearCommand to support new command format
    • Refactoring of models to support running count for implementation of IDs
    • Updated test cases in the above to work
    • Adding of FindAppointmentCommand
      • Created new predicates
      • Find by date and person name
    • Autosorting of listed appointments by date
    • Autosorting of listed persons by name
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    +
  • About Us

    • Project: DocTrack

    DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

    Role:

    • Team Lead
    • Developer
    • Integration

    Given below are my contributions to the project:

    • Refactoring Person into PersonDescriptor to support PersonID
    • Refactoring of DeleteCommand to support new command format
    • Refactoring of ClearCommand to support new command format
    • Refactoring of models to support running count for implementation of IDs
    • Updated test cases in the above to work
    • Adding of FindAppointmentCommand
      • Created new predicates
      • Find by date and person name
    • Autosorting of listed appointments by date
    • Autosorting of listed persons by name
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]
    diff --git a/team/zaidansani.page-vue-render.js b/team/zaidansani.page-vue-render.js index 7408c6df095..b3dc499db77 100644 --- a/team/zaidansani.page-vue-render.js +++ b/team/zaidansani.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Role:")]),_v(" "),_c('ul',[_c('li',[_v("Team Lead")]),_v(" "),_c('li',[_v("Developer")]),_v(" "),_c('li',[_v("Integration")])]),_v(" "),_c('p',[_v("Given below are my contributions to the project:")]),_v(" "),_c('ul',[_c('li',[_v("Refactoring Person into PersonDescriptor to support PersonID")]),_v(" "),_c('li',[_v("Refactoring of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommand")]),_v(" to support new command format")]),_v(" "),_c('li',[_v("Refactoring of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ClearCommand")]),_v(" to support new command format")]),_v(" "),_c('li',[_v("Refactoring of models to support running count for implementation of IDs")]),_v(" "),_c('li',[_v("Updated test cases in the above to work")]),_v(" "),_c('li',[_v("Adding of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindAppointmentCommand")]),_v(" "),_c('ul',[_c('li',[_v("Created new predicates")]),_v(" "),_c('li',[_v("Find by date and person name")])])]),_v(" "),_c('li',[_v("Autosorting of listed appointments by date")]),_v(" "),_c('li',[_v("Autosorting of listed persons by name")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 22:10:49 GMT+8]")])])])} }]; \ No newline at end of file