From 5fc517d462d483dbc798f6def8a848f2e3969fa3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 11 Nov 2024 17:41:08 +0000 Subject: [PATCH] deploy: cafb1b922f97f3f411bde670544bca740345eb7e --- 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 | 19 +++++++-------- DeveloperGuide.page-vue-render.js | 31 +++++++++++++----------- 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/choaticman.html | 2 +- team/choaticman.page-vue-render.js | 2 +- team/raghava-chittidi.html | 2 +- team/raghava-chittidi.page-vue-render.js | 2 +- team/woke02.html | 2 +- team/woke02.page-vue-render.js | 2 +- team/xueting.html | 2 +- team/xueting.page-vue-render.js | 2 +- team/zwezeya.html | 2 +- team/zwezeya.page-vue-render.js | 2 +- 30 files changed, 54 insertions(+), 52 deletions(-) diff --git a/AboutUs.html b/AboutUs.html index 86da8095319..24a159d95cd 100644 --- a/AboutUs.html +++ b/AboutUs.html @@ -18,7 +18,7 @@ [portfolio]

Raghava Chittidi

[github] [portfolio]

Dylan Chan

[github] [portfolio]

Kelly Wong

[github] [portfolio]

Wu XueTing

[github] -[portfolio]

+[portfolio]

diff --git a/AboutUs.page-vue-render.js b/AboutUs.page-vue-render.js index 92568b5e994..48ef31e0a62 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 the email "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hireme@gmail.com")])]),_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":"zwe-zeya"}},[_v("Zwe Zeya"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#zwe-zeya","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/zwezeya.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/ZweZeya"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/zwezeya.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: Software Developer")])]),_v(" "),_c('h3',{attrs:{"id":"raghava-chittidi"}},[_v("Raghava Chittidi"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#raghava-chittidi","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/raghava-chittidi.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/Raghava-Chittidi"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/raghava-chittidi.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: Software Developer")])]),_v(" "),_c('h3',{attrs:{"id":"dylan-chan"}},[_v("Dylan Chan"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#dylan-chan","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/choaticman.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/choaticman"}},[_v("github")]),_v("] ["),_c('a',{attrs:{"href":"/tp/team/choaticman.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: Software Developer")])]),_v(" "),_c('h3',{attrs:{"id":"kelly-wong"}},[_v("Kelly Wong"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#kelly-wong","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/woke02.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/woke02"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/woke02.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: Software Developer")])]),_v(" "),_c('h3',{attrs:{"id":"wu-xueting"}},[_v("Wu XueTing"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#wu-xueting","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/snowstopxt.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/snowstopxt"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/xueting.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: UI, FXML, Commands")])])])} },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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index 1d210d50568..cf142a4b2cb 100644 --- a/Configuration.html +++ b/Configuration.html @@ -14,7 +14,7 @@

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).

+

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 754ae60ded0..62024a790a6 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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index f6d450d3759..ca2d79994c8 100644 --- a/DevOps.html +++ b/DevOps.html @@ -16,7 +16,7 @@ Search

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 40442b45fdb..1937259e861 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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index 23478c6ec35..39db59a1b5d 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -14,7 +14,7 @@

    HireMe Developer Guide

    Setting up, getting started

    Refer to the guide Setting up and getting started.

    Design

    Architecture

    The Architecture Diagram given above explains the high-level design of the App.

    Given below is a quick overview of main components and how they interact with each other.

    Main components of the architecture

    Main (consisting of classes Main and MainApp) is in charge of the app launch and shut down.

    • At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
    • At shut down, it shuts down the other components and invokes cleanup methods where necessary.

    The bulk of the app's work is done by the following four components:

    • UI: The UI of the App.
    • Logic: The command executor.
    • Model: Holds the data of the App in memory.
    • Storage: Reads data from, and writes data to, the hard disk.

    Commons represents a collection of classes used by multiple other components.

    How the architecture components interact with each other

    The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command /delete 1.

    Each of the four main components (also shown in the diagram above),

    • defines its API in an interface with the same name as the Component.
    • implements its functionality using a concrete {Component Name}Manager class (which follows the corresponding API interface mentioned in the previous point.

    For example, the Logic component defines its API in the Logic.java interface and implements its functionality using the LogicManager.java class which follows the Logic interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.

    The sections below give more details of each component.



    UI component

    The API of this component is specified in Ui.java

    Structure of the UI Component

    The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, InternshipApplicationListPanel, StatusBarFooter etc. All these, including the MainWindow, inherit from the abstract UiPart class which captures the commonalities between classes that represent parts of the visible GUI.

    The UI component uses the JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

    The UI component,

    • executes user commands using the Logic component.
    • listens for changes to Model data so that the UI can be updated with the modified data.
    • keeps a reference to the Logic component, because the UI relies on the Logic to execute commands.
    • depends on some classes in the Model component, as it displays InternshipApplication object residing in the Model.

    The HelpWindow component is shown when you execute a help command. It contains a link to the detailed user and developer guide on this HireMe documentation website.

    The ChartWindow component is shown when you execute a chart command. It contains a visual representation of the various statuses of your internship applications, in the form of a pie chart.



    Logic component

    API : Logic.java

    Here's a (partial) class diagram of the Logic component:

    How the Logic component works:

    1. When Logic is called upon to execute a command, it is passed to an AddressBookParser object which in turn creates a parser that matches the command (e.g., DeleteCommandParser) and uses it to parse the command.
    2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager.
    3. The command can communicate with the Model when it is executed (e.g. to delete a internship application).
      +

    HireMe Developer Guide

    Setting up, getting started

    Refer to the guide Setting up and getting started.

    Design

    Architecture

    The Architecture Diagram given above explains the high-level design of the App.

    Given below is a quick overview of main components and how they interact with each other.

    Main components of the architecture

    Main (consisting of classes Main and MainApp) is in charge of the app launch and shut down.

    The bulk of the app's work is done by the following four components:

    Commons represents a collection of classes used by multiple other components.

    How the architecture components interact with each other

    The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command /delete 1.

    Each of the four main components (also shown in the diagram above),

    For example, the Logic component defines its API in the Logic.java interface and implements its functionality using the LogicManager.java class which follows the Logic interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.

    The sections below give more details of each component.



    UI component

    The API of this component is specified in Ui.java.

    Structure of the UI Component

    The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, InternshipApplicationListPanel, StatusBarFooter etc. All these, including the MainWindow, inherit from the abstract UiPart class which captures the commonalities between classes that represent parts of the visible GUI.

    The UI component uses the JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml.

    The UI component,

    The HelpWindow component is shown when you execute a help command. It contains a link to the detailed user and developer guide on this HireMe documentation website.

    The ChartWindow component is shown when you execute a chart command. It contains a visual representation of the various statuses of your internship applications, in the form of a pie chart.



    Logic component

    API : Logic.java

    Here's a (partial) class diagram of the Logic component:

    How the Logic component works:

    1. When Logic is called upon to execute a command, it is passed to an AddressBookParser object which in turn creates a parser that matches the command (e.g., DeleteCommandParser) and uses it to parse the command.
    2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager.
    3. The command can communicate with the Model when it is executed (e.g. to delete a internship application).
      Note that although this is shown as a single step in the diagram above (for simplicity), in the code it can take several interactions (between the command object and the Model) to achieve.
    4. The result of the command execution is encapsulated as a CommandResult object which is returned back from Logic.

    Here are the other classes in Logic (omitted from the class diagram above) that are used for parsing a user command:

    How the parsing works:



    Model component

    API : Model.java

    The Model component:



    Storage component

    API : Storage.java

    The Storage component,



    Common classes

    Classes used by multiple components are in the seedu.hireme.commons package.

    Implementation

    This section describes some noteworthy details on how certain features are implemented.

    Getting help

    The implementation of the command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command. In this case, since there are no additional parameters for the help command, AddressBookParser does not create any parser object.

    HelpSequenceDiagram

    AddressBookParser ensures that there are no additional keywords provided. If there are keywords found, AddressBookParser throws a ParseException. Otherwise, it creates a new instance of HelpCommand.

    Upon execution, HelpCommand returns an instance of CommandResult which contains the help message.

    NOTE: Model is not invoked here but included for the sake of clarity.



    Create new internship application

    The implementation of the create command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command. @@ -23,7 +23,7 @@ If any of the above constraints are violated, AddressBookParser throws a ParseException. Otherwise, it creates a new instance of AddCommand that corresponds to the user input. AddCommand comprises of the internship application to be added, which is an instance of InternshipApplication.

    Upon execution, AddCommand first queries the supplied model if it contains a duplicate internship application. If no duplicate internship application exists, then AddCommand adds the internship application into the data.

    NOTE: HireMe identifies an entry as a duplicate if its NAME, ROLE, EMAIL and DATE match (case-insensitive) with those of an existing internship application entry. Attempting to add a duplicate will result in an error.



    List all internship applications

    The implementation of the list command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command.

    ListSequenceDiagram

    AddressBookParser creates ListCommand Upon execution, ListCommand calls on model::updateFilteredList to show all internship applications.



    Delete an internship application

    The implementation of the delete command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command.

    In this case, AddressBookParser creates DeleteCommandParser to parse user input string.

    DeleteSequenceDiagram

    AddressBookParser first obtains the index from the user's input. -AddressBookParser ensures that there is only 1 keyword found which is a number. If there is no valid keyword found, AddressBookParser throws a ParseException. +AddressBookParser ensures that there is only one keyword found which is a number. If there is no valid keyword found, AddressBookParser throws a ParseException. Otherwise, it creates a new instance of DeleteCommand that corresponds to the user input. DeleteCommand comprises of a targetIndex which is the zero based index number of the internship application to be deleted.

    Upon execution, DeleteCommand gets the internship application to be deleted and calls on model::deleteItem which deletes it from the list.

    NOTE: The sequence diagram shows a simplified execution of the DeleteCommand.



    Update the status of an internship application

    The StatusCommand updates the status of an internship application to PENDING, ACCEPTED, or REJECTED, triggered by commands /pending, /accept, or /reject respectively. The implementation of the status command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command.

    In this case, AddressBookParser creates StatusCommandParser to parse user input string.

    StatusSequenceDiagram

    The sequence diagram above illustrates the flow for the /accept command. Similar flows apply for /reject and /pending.

    AddressBookParser first obtains the index from the user's input.
    AddressBookParser ensures that there is only one keyword found, which is a number. If no valid keyword is found, AddressBookParser throws a ParseException. Otherwise, it creates a new instance of StatusCommand based on the user input, with the StatusCommand containing the target index and specified status.

    Upon execution, StatusCommand retrieves the internship application to be updated and calls model::setItem to update the status within the list.

    StatusActivityDiagram > **_NOTE:_** The sequence diagram shows a simplified execution of the StatusCommand. @@ -39,11 +39,10 @@ In this case, AddressBookParser creates SortCommandParser to parse user input string.

    SortSequenceDiagram

    AddressBookParser first obtains the order from the user's input. AddressBookParser ensures that there is only 1 keyword found which is the sorting order. If there is no valid keyword found, AddressBookParser throws a ParseException. Otherwise, it creates a new instance of SortCommand that corresponds to the user input. -SortCommand comprises of a DateComparator which contains the sorting order, according to date of application, that the internship application list should be sorted by.

    Upon execution, SortCommand calls on model::sortFilteredList which in turns calls on addressBook::sortItems. -sortItems updates the filteredList in model to sort the internship applications in the list according to the order specified by the user.



    Clear

    The implementation of the command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command.

    ClearSequenceDiagram

    AddressBookParser creates ClearCommand. +SortCommand comprises of a DateComparator which contains the sorting order, according to date of application, that the internship application list should be sorted by.

    Upon execution, SortCommand calls on model::sortFilteredList which in turns calls on addressBook::sortItems. +sortItems updates the filteredList in Model to sort the internship applications in the list according to the order specified by the user.



    Clear

    The implementation of the command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command.

    ClearSequenceDiagram

    AddressBookParser creates ClearCommand. Upon execution, ClearCommand calls on model::setAddressBook with a new address book that has zero internship applications. Finally, ClearCommand generates a CommandResult with a confirmation message.

    NOTE: The sequence diagram shows a simplified execution of the ClearCommand.



    View chart

    The implementation of the chart command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command.

    ChartSequenceDiagram

    AddressBookParser creates ChartCommand. -Upon execution, ChartCommand gets the chart data which is encapsulated in CommandResult



    Close the application

    The implementation of the command follows the convention of a normal command, where AddressBookParser is responsible for parsing the user input string into an executable command.

    ExitSequenceDiagram

    AddressBookParser creates ExitCommand -Upon execution, ExitCommand encapsulates the intent to close the application in CommandResult.

    NOTE: Model is not invoked here but included for the sake of clarity.



    Documentation, logging, testing, configuration, dev-ops

    Appendix: Requirements

    Product scope

    Target user profile:

    Value proposition: manage internships faster than a typical mouse/GUI driven app



    User stories

    Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (future plans) - *

    Priority As a …​ I want to …​ So that …​
    * * * CS Undergraduate list all the internship applications I can view all my past applications
    * * * Forgetful CS Undergraduate have a link to HireMe's help page I can see all the different commands that I can use
    * * * An efficient CS Undergraduate type the commands I do not have to lift my fingers off the keyboard
    * * * CS Undergraduate add an internship application I can add on to the records of all the internships I have applied to
    * * * CS Undergraduate delete an internship application I can remove invalid or irrelevant applications
    * * * CS Undergraduate save the internship application data locally I will not lose my data when I exit the application
    * * * CS Undergraduate load the internship from a saved file I can get back my data when I open the application
    * * * CS Undergraduate clear the list of internship application I have saved I can restart a new list in the next internship application cycle
    * * * CS Undergraduate find internship applications by company name I can quickly locate specific applications for review or updates
    * * * CS Undergraduate update the status of an internship application to accepted, pending, or rejected I can update the status of each application accurately
    * * Meticulous CS Undergraduate sort the list of internship applications by date of application I can prioritize follow-ups with older applications
    * * Curious CS Undergraduate see a chart that summarises the statuses of all my applications I know know the breakdown of each status
    * Organised CS Undergraduate view the interview dates for different internships applications I can update my schedule accordingly
    * Efficient CS Undergraduate view my most desired internship applications by favouriting them I can prioritize my time on checking up on these internship applications
    * Forgetful CS Undergraduate remind myself of acceptance deadline I will not miss the deadline to accept

    {More to be added}



    Use cases

    System: HireMe application

    Use Case: UC01 - Add a new internship entry

    Actor: User

    MSS (Main Success Scenario)

    1. The user requests to add a new internship entry.

    2. HireMe creates a new entry.

      Use case ends.

    Extensions



    System: HireMe application

    Use Case: UC02 - List all internship entries

    Actor: User

    MSS (Main Success Scenario)

    1. The user requests to list all internship entries.

    2. HireMe shows all internship entries.

      Use case ends.

    Extensions



    Launch

    1. Initial launch

      1. Download the jar file and copy into an empty folder

      2. Run java -jar hireme.jar in a terminal.
        +Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

    2. Saving window preferences

      1. Resize the window to an optimum size. Move the window to a different location. Close the window.

      2. Re-launch the app by running java -jar hireme.jar in a terminal.
        Expected: The most recent window size and location is retained.



    Help Window

    1. Opening Help window via Command Line

      1. Prerequisite: Help window is not open.

      2. Test case: /help
        Expected: Help window opens.

    2. Opening Help window via F1

      1. Prerequisite: Help window is not open.

      2. Test case: Click the F1 key on your keyboard.
        Expected: Help window opens.

    3. Opening Help window via Tool Bar

      1. Prerequisite: Help window is not open.

      2. Test case: Click on the Help button on the Tool Bar, and then click on the Help F1 button on the drop down.
        @@ -119,9 +119,8 @@ on why the command is invalid. The error message could be more specific to state the email field is missing.

      3. Planned enhancement: We plan to improve the validator to be able to detect specifically why the command is invalid, and provide a more specific error message.

      4. Justification: In doing so, users will have a clearer idea on what they did wrong when they typed in the command and they will be able to easily fix the issue. This enables the users to have a more pleasant experience when using HireMe. -

      5. Improve UI to deal with long texts: The current application does not allow the user to scroll the list displayed on the application. -If there is a very long text, the text will be cut off and the use would have to maximise the application's window in order to see the full text. -We plan to implement scroll bars within the list displayed in the application, to allow the user to scroll and see any long texts.

      6. Improve the validator for email

        • Current behaviour: Although the current email validator accepts most valid email addresses, there are still certain valid email addresses (e.g. faceb__k@fb.com.sg) that it might incorrectly flag out as invalid addresses.

        • Planned enhancement: A fix for the email validator to accept valid emails with more combinations of special characters.

        • Justification: Company emails with uncommon combinations of special characters in their email addresses will be considered invalid and hence, users will not be able to include such internship application in the HireMe tracking system.

      7. User confirmation for clear command

        • Current behaviour: The clear command clears all internship applications without asking for user confirmation.

        • Planned enhancement: HireMe to prompt the user for confirmation on clear command. If the user confirms, then all internship applications will be cleared. Otherwise, no action will be taken and the internship applications remain.

        • Justification: HireMe does not support any form of undo action and hence, there is no safety mechanism against accidental clearing of internship applications by the user. By having a confirmation, it ensures that clear is only carried out deliberately.

      8. Backup file for storage

        • Current behaviour: Internship applications data is stored in a single data file hireme.json.

        • Planned enhancement: A backup file that replicates the data in hireme.json.

        • Justification: Having only a single data file to store internship applications data means having a single point of failure when the data in corrupted or lost. A backup file that synchronously replicates the data in hireme.json ensures data redundancy.

      [Powered by MarkBind 5.5.3, generated on Tue, 12 Nov 2024, 1:40:48 GMT+8]
      +

    4. Improve UI to deal with long texts:

    5. Improve the validator for email

    6. User confirmation for clear command

    7. Backup file for storage

    diff --git a/DeveloperGuide.page-vue-render.js b/DeveloperGuide.page-vue-render.js index e9de420745c..42fa4b0ad39 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("HireMe")])]},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/AY2425S1-CS2103T-W09-3/tp","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:"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#overview-of-user-guide"}},[_v("Overview of User Guide")])])]),_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#how-to-use-our-user-guide"}},[_v("How to use our User Guide")])])]),_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#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#troubleshooting"}},[_v("Troubleshooting")])])]),_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#command-summary"}},[_v("Command summary")])])]),_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#glossary"}},[_v("Glossary")])])]),_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#acknowledgements"}},[_v("Acknowledgements")])])])])]),_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)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('hr'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('hr'),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureDiagram.png","width":"280"}}),_v(" "),_m(6),_v(" "),_c('p',[_v("Given below is a quick overview of main components and how they interact with each other.")]),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('p',[_v("The bulk of the app's work is done by the following four components:")]),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_m(13),_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(14),_v(" "),_m(15),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ComponentManagers.png","width":"300"}}),_v(" "),_c('p',[_v("The sections below give more details of each component.")]),_v(" "),_m(16),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/UiClassDiagram.png","alt":"Structure of the UI Component"}}),_v(" "),_m(19),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_m(22),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_m(28),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/LogicClassDiagram.png","width":"550"}}),_v(" "),_m(29),_v(" "),_m(30),_v(" "),_m(31),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ParserClasses.png","width":"600"}}),_v(" "),_c('p',[_v("How the parsing works:")]),_v(" "),_m(32),_v(" "),_m(33),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ModelClassDiagram.png","width":"450"}}),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_m(40),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StorageClassDiagram.png","width":"550"}}),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_m(43),_v(" "),_m(44),_v(" "),_m(45),_v(" "),_c('hr'),_v(" "),_m(46),_v(" "),_c('p',[_v("This section describes some noteworthy details on how certain features are implemented.")]),_v(" "),_m(47),_v(" "),_m(48),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/HelpSequenceDiagram.png","alt":"HelpSequenceDiagram"}}),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/AddSequenceDiagram.png","alt":"AddSequenceDiagram"}}),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ListSequenceDiagram.png","alt":"ListSequenceDiagram"}}),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_m(66),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/DeleteSequenceDiagram.png","alt":"DeleteSequenceDiagram"}}),_v(" "),_m(67),_v(" "),_m(68),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StatusActivityDiagram.png","alt":"StatusActivityDiagram"}}),_v("\n> **_NOTE:_** The sequence diagram shows a simplified execution of the StatusCommand.\n"),_m(78),_v(" "),_m(79),_v(" "),_m(80),_v(" "),_m(81),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/FindSequenceDiagram.png","alt":"FindSequenceDiagram"}}),_v(" "),_m(82),_v(" "),_m(83),_v(" "),_m(84),_v(" "),_m(85),_v(" "),_m(86),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/FilterSequenceDiagram.png","alt":"FilterSequenceDiagram"}}),_v(" "),_m(87),_v(" "),_m(88),_v(" "),_m(89),_v(" "),_m(90),_v(" "),_m(91),_v(" "),_m(92),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/SortSequenceDiagram.png","alt":"SortSequenceDiagram"}}),_v(" "),_m(93),_v(" "),_m(94),_v(" "),_m(95),_v(" "),_m(96),_v(" "),_m(97),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ClearSequenceDiagram.png","alt":"ClearSequenceDiagram"}}),_v(" "),_m(98),_v(" "),_m(99),_v(" "),_m(100),_v(" "),_m(101),_v(" "),_m(102),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ChartSequenceDiagram.png","alt":"ChartSequenceDiagram"}}),_v(" "),_m(103),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_m(106),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ExitSequenceDiagram.png","alt":"ExitSequenceDiagram"}}),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_m(109),_v(" "),_c('hr'),_v(" "),_m(110),_v(" "),_m(111),_v(" "),_c('hr'),_v(" "),_m(112),_v(" "),_m(113),_v(" "),_m(114),_v(" "),_m(115),_v(" "),_m(116),_v(" "),_m(117),_v(" "),_m(118),_v(" "),_m(119),_v(" "),_m(120),_m(121),_v(" "),_m(122),_v(" "),_m(123),_v(" "),_m(124),_v(" "),_m(125),_v(" "),_m(126),_v(" "),_m(127),_v(" "),_m(128),_v(" "),_m(129),_v(" "),_m(130),_v(" "),_m(131),_v(" "),_m(132),_v(" "),_m(133),_v(" "),_m(134),_v(" "),_m(135),_v(" "),_m(136),_v(" "),_m(137),_v(" "),_m(138),_v(" "),_m(139),_v(" "),_m(140),_v(" "),_m(141),_v(" "),_m(142),_v(" "),_m(143),_v(" "),_m(144),_v(" "),_m(145),_v(" "),_m(146),_v(" "),_m(147),_v(" "),_m(148),_v(" "),_m(149),_v(" "),_m(150),_v(" "),_m(151),_v(" "),_m(152),_v(" "),_m(153),_v(" "),_m(154),_v(" "),_m(155),_v(" "),_m(156),_v(" "),_m(157),_v(" "),_m(158),_v(" "),_m(159),_v(" "),_m(160),_v(" "),_m(161),_v(" "),_m(162),_v(" "),_m(163),_v(" "),_m(164),_v(" "),_m(165),_v(" "),_m(166),_v(" "),_m(167),_v(" "),_m(168),_v(" "),_m(169),_v(" "),_m(170),_v(" "),_m(171),_v(" "),_m(172),_v(" "),_m(173),_v(" "),_m(174),_v(" "),_m(175),_v(" "),_m(176),_v(" "),_m(177),_v(" "),_m(178),_v(" "),_m(179),_v(" "),_m(180),_v(" "),_m(181),_v(" "),_m(182),_v(" "),_m(183),_v(" "),_m(184),_v(" "),_m(185),_v(" "),_m(186),_v(" "),_m(187),_v(" "),_m(188),_v(" "),_m(189),_v(" "),_m(190),_v(" "),_m(191),_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(" "),_m(216),_v(" "),_m(217),_v(" "),_m(218),_v(" "),_m(219),_v(" "),_m(220),_v(" "),_c('hr'),_v(" "),_m(221),_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(" "),_m(222),_v(" "),_m(223),_v(" "),_m(224),_v(" "),_m(225),_v(" "),_m(226),_v(" "),_m(227),_v(" "),_m(228),_v(" "),_m(229),_v(" "),_m(230),_v(" "),_m(231),_v(" "),_m(232),_v(" "),_m(233),_v(" "),_m(234),_v(" "),_m(235),_v(" "),_m(236),_v(" "),_m(237),_v(" "),_m(238),_v(" "),_m(239),_v(" "),_m(240),_v(" "),_m(241),_v(" "),_m(242),_v(" "),_m(243),_v(" "),_m(244),_v(" "),_m(245),_v(" "),_m(246),_v(" "),_m(247),_v(" "),_m(248),_v(" "),_m(249),_v(" "),_m(250),_v(" "),_m(251),_v(" "),_m(252),_v(" "),_m(253),_v(" "),_m(254),_v(" "),_m(255),_v(" "),_m(256),_v(" "),_m(257),_v(" "),_m(258),_v(" "),_m(259),_v(" "),_m(260),_v(" "),_c('hr'),_v(" "),_m(261),_v(" "),_m(262),_v(" "),_m(263)],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":"#hireme-developer-guide"}},[_v("HireMe 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":"#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":"#implementation"}},[_v("Implementation‎")]),_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":"#getting-help"}},[_v("Getting help‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-new-internship-application"}},[_v("Create new internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#list-all-internship-applications"}},[_v("List all internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#delete-an-internship-application"}},[_v("Delete an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#update-the-status-of-an-internship-application"}},[_v("Update the status of an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#find-internship-applications"}},[_v("Find internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#filter-internship-applications"}},[_v("Filter internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#sort-internship-application-list"}},[_v("Sort internship application list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clear"}},[_v("Clear‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#view-chart"}},[_v("View chart‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#close-the-application"}},[_v("Close the application‎")])]),_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-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"}},[_v("Launch‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#help-window"}},[_v("Help Window‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-all-internship-applications"}},[_v("Clearing all internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-an-internship-application"}},[_v("Adding an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#list"}},[_v("List‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-an-internship-application"}},[_v("Deleting an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#sorting-the-list-of-internship-applications"}},[_v("Sorting the list of internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-internship-applications"}},[_v("Finding internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-the-status-of-an-internship-application"}},[_v("Updating the status of an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#chart-window"}},[_v("Chart Window‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#filtering-internship-applications"}},[_v("Filtering internship applications‎")]),_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":"#exit-hireme-application"}},[_v("Exit HireMe Application‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-planned-enhancements"}},[_v("Appendix: Planned Enhancements‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(264)])} +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("HireMe")])]},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/AY2425S1-CS2103T-W09-3/tp","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:"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#overview-of-user-guide"}},[_v("Overview of User Guide")])])]),_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#how-to-use-our-user-guide"}},[_v("How to use our User Guide")])])]),_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#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#troubleshooting"}},[_v("Troubleshooting")])])]),_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#command-summary"}},[_v("Command summary")])])]),_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#glossary"}},[_v("Glossary")])])]),_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#acknowledgements"}},[_v("Acknowledgements")])])])])]),_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)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('hr'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('hr'),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureDiagram.png","width":"280"}}),_v(" "),_m(6),_v(" "),_c('p',[_v("Given below is a quick overview of main components and how they interact with each other.")]),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('p',[_v("The bulk of the app's work is done by the following four components:")]),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_m(13),_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(14),_v(" "),_m(15),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ComponentManagers.png","width":"300"}}),_v(" "),_c('p',[_v("The sections below give more details of each component.")]),_v(" "),_m(16),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/UiClassDiagram.png","alt":"Structure of the UI Component"}}),_v(" "),_m(19),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_m(22),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_m(28),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/LogicClassDiagram.png","width":"550"}}),_v(" "),_m(29),_v(" "),_m(30),_v(" "),_m(31),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ParserClasses.png","width":"600"}}),_v(" "),_c('p',[_v("How the parsing works:")]),_v(" "),_m(32),_v(" "),_m(33),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ModelClassDiagram.png","width":"450"}}),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_m(40),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StorageClassDiagram.png","width":"550"}}),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_m(43),_v(" "),_m(44),_v(" "),_m(45),_v(" "),_c('hr'),_v(" "),_m(46),_v(" "),_c('p',[_v("This section describes some noteworthy details on how certain features are implemented.")]),_v(" "),_m(47),_v(" "),_m(48),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/HelpSequenceDiagram.png","alt":"HelpSequenceDiagram"}}),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/AddSequenceDiagram.png","alt":"AddSequenceDiagram"}}),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ListSequenceDiagram.png","alt":"ListSequenceDiagram"}}),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_m(66),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/DeleteSequenceDiagram.png","alt":"DeleteSequenceDiagram"}}),_v(" "),_m(67),_v(" "),_m(68),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StatusActivityDiagram.png","alt":"StatusActivityDiagram"}}),_v("\n> **_NOTE:_** The sequence diagram shows a simplified execution of the StatusCommand.\n"),_m(78),_v(" "),_m(79),_v(" "),_m(80),_v(" "),_m(81),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/FindSequenceDiagram.png","alt":"FindSequenceDiagram"}}),_v(" "),_m(82),_v(" "),_m(83),_v(" "),_m(84),_v(" "),_m(85),_v(" "),_m(86),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/FilterSequenceDiagram.png","alt":"FilterSequenceDiagram"}}),_v(" "),_m(87),_v(" "),_m(88),_v(" "),_m(89),_v(" "),_m(90),_v(" "),_m(91),_v(" "),_m(92),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/SortSequenceDiagram.png","alt":"SortSequenceDiagram"}}),_v(" "),_m(93),_v(" "),_m(94),_v(" "),_m(95),_v(" "),_m(96),_v(" "),_m(97),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ClearSequenceDiagram.png","alt":"ClearSequenceDiagram"}}),_v(" "),_m(98),_v(" "),_m(99),_v(" "),_m(100),_v(" "),_m(101),_v(" "),_m(102),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ChartSequenceDiagram.png","alt":"ChartSequenceDiagram"}}),_v(" "),_m(103),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_m(106),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ExitSequenceDiagram.png","alt":"ExitSequenceDiagram"}}),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_m(109),_v(" "),_m(110),_v(" "),_c('hr'),_v(" "),_m(111),_v(" "),_m(112),_v(" "),_c('hr'),_v(" "),_m(113),_v(" "),_m(114),_v(" "),_m(115),_v(" "),_m(116),_v(" "),_m(117),_v(" "),_m(118),_v(" "),_m(119),_v(" "),_m(120),_v(" "),_m(121),_m(122),_v(" "),_m(123),_v(" "),_m(124),_v(" "),_m(125),_v(" "),_m(126),_v(" "),_m(127),_v(" "),_m(128),_v(" "),_m(129),_v(" "),_m(130),_v(" "),_m(131),_v(" "),_m(132),_v(" "),_m(133),_v(" "),_m(134),_v(" "),_m(135),_v(" "),_m(136),_v(" "),_m(137),_v(" "),_m(138),_v(" "),_m(139),_v(" "),_m(140),_v(" "),_m(141),_v(" "),_m(142),_v(" "),_m(143),_v(" "),_m(144),_v(" "),_m(145),_v(" "),_m(146),_v(" "),_m(147),_v(" "),_m(148),_v(" "),_m(149),_v(" "),_m(150),_v(" "),_m(151),_v(" "),_m(152),_v(" "),_m(153),_v(" "),_m(154),_v(" "),_m(155),_v(" "),_m(156),_v(" "),_m(157),_v(" "),_m(158),_v(" "),_m(159),_v(" "),_m(160),_v(" "),_m(161),_v(" "),_m(162),_v(" "),_m(163),_v(" "),_m(164),_v(" "),_m(165),_v(" "),_m(166),_v(" "),_m(167),_v(" "),_m(168),_v(" "),_m(169),_v(" "),_m(170),_v(" "),_m(171),_v(" "),_m(172),_v(" "),_m(173),_v(" "),_m(174),_v(" "),_m(175),_v(" "),_m(176),_v(" "),_m(177),_v(" "),_m(178),_v(" "),_m(179),_v(" "),_m(180),_v(" "),_m(181),_v(" "),_m(182),_v(" "),_m(183),_v(" "),_m(184),_v(" "),_m(185),_v(" "),_m(186),_v(" "),_m(187),_v(" "),_m(188),_v(" "),_m(189),_v(" "),_m(190),_v(" "),_m(191),_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(" "),_m(216),_v(" "),_m(217),_v(" "),_m(218),_v(" "),_m(219),_v(" "),_m(220),_v(" "),_m(221),_v(" "),_c('hr'),_v(" "),_m(222),_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(" "),_m(223),_v(" "),_m(224),_v(" "),_m(225),_v(" "),_m(226),_v(" "),_m(227),_v(" "),_m(228),_v(" "),_m(229),_v(" "),_m(230),_v(" "),_m(231),_v(" "),_m(232),_v(" "),_m(233),_v(" "),_m(234),_v(" "),_m(235),_v(" "),_m(236),_v(" "),_m(237),_v(" "),_m(238),_v(" "),_m(239),_v(" "),_m(240),_v(" "),_m(241),_v(" "),_m(242),_v(" "),_m(243),_v(" "),_m(244),_v(" "),_m(245),_v(" "),_m(246),_v(" "),_m(247),_v(" "),_m(248),_v(" "),_m(249),_v(" "),_m(250),_v(" "),_m(251),_v(" "),_m(252),_v(" "),_m(253),_v(" "),_m(254),_v(" "),_m(255),_v(" "),_m(256),_v(" "),_m(257),_v(" "),_m(258),_v(" "),_m(259),_v(" "),_m(260),_v(" "),_m(261),_v(" "),_c('hr'),_v(" "),_m(262),_v(" "),_m(263),_v(" "),_m(264)],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":"#hireme-developer-guide"}},[_v("HireMe 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":"#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":"#implementation"}},[_v("Implementation‎")]),_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":"#getting-help"}},[_v("Getting help‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#create-new-internship-application"}},[_v("Create new internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#list-all-internship-applications"}},[_v("List all internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#delete-an-internship-application"}},[_v("Delete an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#update-the-status-of-an-internship-application"}},[_v("Update the status of an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#find-internship-applications"}},[_v("Find internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#filter-internship-applications"}},[_v("Filter internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#sort-internship-application-list"}},[_v("Sort internship application list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clear"}},[_v("Clear‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#view-chart"}},[_v("View chart‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#close-the-application"}},[_v("Close the application‎")])]),_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-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"}},[_v("Launch‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#help-window"}},[_v("Help Window‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-all-internship-applications"}},[_v("Clearing all internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-an-internship-application"}},[_v("Adding an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#list"}},[_v("List‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-an-internship-application"}},[_v("Deleting an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#sorting-the-list-of-internship-applications"}},[_v("Sorting the list of internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-internship-applications"}},[_v("Finding internship applications‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#updating-the-status-of-an-internship-application"}},[_v("Updating the status of an internship application‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#chart-window"}},[_v("Chart Window‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#filtering-internship-applications"}},[_v("Filtering internship applications‎")]),_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":"#exit-hireme-application"}},[_v("Exit HireMe Application‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-planned-enhancements"}},[_v("Appendix: Planned Enhancements‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(265)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -47,7 +47,7 @@ with(this){return _c('p',[_c('strong',[_v("How the architecture components inter with(this){return _c('p',[_v("The "),_c('em',[_v("Sequence Diagram")]),_v(" below shows how the components interact with each other for the scenario where the user issues the command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/delete 1")]),_v(".")])} },function anonymous( ) { -with(this){return _c('ul',[_c('li',[_v("defines its "),_c('em',[_v("API")]),_v(" in an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("interface")]),_v(" with the same name as the Component.")]),_v(" "),_c('li',[_v("implements its functionality using a concrete "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("{Component Name}Manager")]),_v(" class (which follows the corresponding API "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("interface")]),_v(" mentioned in the previous point.")])])} +with(this){return _c('ul',[_c('li',[_v("defines its "),_c('em',[_v("API")]),_v(" in an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("interface")]),_v(" with the same name as the Component.")]),_v(" "),_c('li',[_v("implements its functionality using a concrete "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("{Component Name}Manager")]),_v(" class which follows the corresponding API "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("interface")]),_v(" mentioned in the previous point.")])])} },function anonymous( ) { with(this){return _c('p',[_v("For example, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Logic")]),_v(" component defines its API in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Logic.java")]),_v(" interface and implements its functionality using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LogicManager.java")]),_v(" class which follows the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Logic")]),_v(" interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.")])} @@ -59,13 +59,13 @@ with(this){return _c('p',[_c('br'),_c('br')])} with(this){return _c('h3',{attrs:{"id":"ui-component"}},[_v("UI component"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ui-component","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('p',[_v("The "),_c('strong',[_v("API")]),_v(" of this component is specified in "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ui.java")])])])} +with(this){return _c('p',[_v("The "),_c('strong',[_v("API")]),_v(" of this component is specified in "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ui.java")])]),_v(".")])} },function anonymous( ) { with(this){return _c('p',[_v("The UI consists of a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainWindow")]),_v(" that is made up of parts e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommandBox")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ResultDisplay")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("InternshipApplicationListPanel")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("StatusBarFooter")]),_v(" etc. All these, including the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainWindow")]),_v(", inherit from the abstract "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UiPart")]),_v(" class which captures the commonalities between classes that represent parts of the visible GUI.")])} },function anonymous( ) { -with(this){return _c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UI")]),_v(" component uses the JavaFx UI framework. The layout of these UI parts are defined in matching "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".fxml")]),_v(" files that are in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("src/main/resources/view")]),_v(" folder. For example, the layout of the "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainWindow")])]),_v(" is specified in "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainWindow.fxml")])])])} +with(this){return _c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UI")]),_v(" component uses the JavaFx UI framework. The layout of these UI parts are defined in matching "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".fxml")]),_v(" files that are in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("src/main/resources/view")]),_v(" folder. For example, the layout of the "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainWindow")])]),_v(" is specified in "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainWindow.fxml")])]),_v(".")])} },function anonymous( ) { with(this){return _c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UI")]),_v(" component,")])} @@ -206,7 +206,7 @@ with(this){return _c('p',[_v("The implementation of the delete command follows t with(this){return _c('p',[_v("In this case, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" creates "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommandParser")]),_v(" to parse user input string.")])} },function anonymous( ) { -with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" first obtains the index from the user's input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" ensures that there is only 1 keyword found which is a number. If there is no valid keyword found, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" throws a ParseException.\nOtherwise, it creates a new instance of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommand")]),_v(" that corresponds to the user input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommand")]),_v(" comprises of a targetIndex which is the zero based index number of the internship application to be deleted.")])} +with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" first obtains the index from the user's input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" ensures that there is only one keyword found which is a number. If there is no valid keyword found, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" throws a ParseException.\nOtherwise, it creates a new instance of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommand")]),_v(" that corresponds to the user input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommand")]),_v(" comprises of a targetIndex which is the zero based index number of the internship application to be deleted.")])} },function anonymous( ) { with(this){return _c('p',[_v("Upon execution, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommand")]),_v(" gets the internship application to be deleted and calls on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model::deleteItem")]),_v(" which deletes it from the list.")])} @@ -284,10 +284,10 @@ with(this){return _c('h3',{attrs:{"id":"sort-internship-application-list"}},[_v( with(this){return _c('p',[_v("The implementation of the command follows the convention of a normal command, where "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" is responsible for parsing the user input string into an executable command.\nIn this case, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" creates "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SortCommandParser")]),_v(" to parse user input string.")])} },function anonymous( ) { -with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" first obtains the order from the user's input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" ensures that there is only 1 keyword found which is the sorting order. If there is no valid keyword found, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" throws a ParseException.\nOtherwise, it creates a new instance of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SortCommand")]),_v(" that corresponds to the user input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SortCommand")]),_v(" comprises of a DateComparator which contains the sorting order, according to date of application, that the internship application list should be sorted by.")])} +with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" first obtains the order from the user's input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" ensures that there is only 1 keyword found which is the sorting order. If there is no valid keyword found, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" throws a ParseException.\nOtherwise, it creates a new instance of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SortCommand")]),_v(" that corresponds to the user input.\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SortCommand")]),_v(" comprises of a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DateComparator")]),_v(" which contains the sorting order, according to date of application, that the internship application list should be sorted by.")])} },function anonymous( ) { -with(this){return _c('p',[_v("Upon execution, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SortCommand")]),_v(" calls on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model::sortFilteredList")]),_v(" which in turns calls on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addressBook::sortItems")]),_v(".\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sortItems")]),_v(" updates the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filteredList")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model")]),_v(" to sort the internship applications in the list according to the order specified by the user.")])} +with(this){return _c('p',[_v("Upon execution, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SortCommand")]),_v(" calls on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model::sortFilteredList")]),_v(" which in turns calls on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addressBook::sortItems")]),_v(".\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sortItems")]),_v(" updates the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filteredList")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Model")]),_v(" to sort the internship applications in the list according to the order specified by the user.")])} },function anonymous( ) { with(this){return _c('p',[_c('br'),_c('br')])} @@ -314,7 +314,7 @@ with(this){return _c('h3',{attrs:{"id":"view-chart"}},[_v("View chart"),_c('a',{ with(this){return _c('p',[_v("The implementation of the chart command follows the convention of a normal command, where "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" is responsible for parsing the user input string into an executable command.")])} },function anonymous( ) { -with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" creates "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ChartCommand")]),_v(".\nUpon execution, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ChartCommand")]),_v(" gets the chart data which is encapsulated in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommandResult")])])} +with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" creates "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ChartCommand")]),_v(".\nUpon execution, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ChartCommand")]),_v(" gets the chart data which is encapsulated in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommandResult")]),_v(".")])} },function anonymous( ) { with(this){return _c('p',[_c('br'),_c('br')])} @@ -326,7 +326,10 @@ with(this){return _c('h3',{attrs:{"id":"close-the-application"}},[_v("Close the with(this){return _c('p',[_v("The implementation of the command follows the convention of a normal command, where "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" is responsible for parsing the user input string into an executable command.")])} },function anonymous( ) { -with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" creates "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ExitCommand")]),_v("\nUpon execution, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ExitCommand")]),_v(" encapsulates the intent to close the application in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommandResult")]),_v(".")])} +with(this){return _c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBookParser")]),_v(" creates "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ExitCommand")]),_v(".")])} +},function anonymous( +) { +with(this){return _c('p',[_v("Upon execution, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ExitCommand")]),_v(" encapsulates the intent to close the application in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommandResult")]),_v(".")])} },function anonymous( ) { with(this){return _c('blockquote',[_c('p',[_c('strong',[_c('em',[_v("NOTE:")])]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Model")]),_v(" is not invoked here but included for the sake of clarity.")])])} @@ -353,7 +356,7 @@ with(this){return _c('p',[_c('strong',[_v("Target user profile")]),_v(":")])} with(this){return _c('ul',[_c('li',[_v("studies at School of Computing in NUS")]),_v(" "),_c('li',[_v("is constantly applying for internships")]),_v(" "),_c('li',[_v("has a need to keep track of significant number of internships")]),_v(" "),_c('li',[_v("can type fast")]),_v(" "),_c('li',[_v("prefers typing to mouse interaction")]),_v(" "),_c('li',[_v("is reasonably comfortable using CLI apps")])])} },function anonymous( ) { -with(this){return _c('p',[_c('strong',[_v("Value proposition")]),_v(": manage internships faster than a typical mouse/GUI driven app")])} +with(this){return _c('p',[_c('strong',[_v("Value proposition")]),_v(": HireMe is a free desktop application that helps you manage your extensive list of internship applications.")])} },function anonymous( ) { with(this){return _c('p',[_c('br'),_c('br')])} @@ -365,7 +368,7 @@ with(this){return _c('h3',{attrs:{"id":"user-stories"}},[_v("User stories"),_c(' with(this){return _c('p',[_v("Priorities: High (must have) - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")]),_v(", Medium (nice to have) - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* *")]),_v(", Low (future plans) - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("*")])])} },function anonymous( ) { -with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Priority")]),_v(" "),_c('th',[_v("As a …​")]),_v(" "),_c('th',[_v("I want to …​")]),_v(" "),_c('th',[_v("So that …​")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("list all the internship applications")]),_v(" "),_c('td',[_v("I can view all my past applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("Forgetful CS Undergraduate")]),_v(" "),_c('td',[_v("have a link to HireMe's help page")]),_v(" "),_c('td',[_v("I can see all the different commands that I can use")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("An efficient CS Undergraduate")]),_v(" "),_c('td',[_v("type the commands")]),_v(" "),_c('td',[_v("I do not have to lift my fingers off the keyboard")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("add an internship application")]),_v(" "),_c('td',[_v("I can add on to the records of all the internships I have applied to")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("delete an internship application")]),_v(" "),_c('td',[_v("I can remove invalid or irrelevant applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("save the internship application data locally")]),_v(" "),_c('td',[_v("I will not lose my data when I exit the application")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("load the internship from a saved file")]),_v(" "),_c('td',[_v("I can get back my data when I open the application")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("clear the list of internship application I have saved")]),_v(" "),_c('td',[_v("I can restart a new list in the next internship application cycle")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("find internship applications by company name")]),_v(" "),_c('td',[_v("I can quickly locate specific applications for review or updates")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("update the status of an internship application to accepted, pending, or rejected")]),_v(" "),_c('td',[_v("I can update the status of each application accurately")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* *")])]),_v(" "),_c('td',[_v("Meticulous CS Undergraduate")]),_v(" "),_c('td',[_v("sort the list of internship applications by date of application")]),_v(" "),_c('td',[_v("I can prioritize follow-ups with older applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* *")])]),_v(" "),_c('td',[_v("Curious CS Undergraduate")]),_v(" "),_c('td',[_v("see a chart that summarises the statuses of all my applications")]),_v(" "),_c('td',[_v("I know know the breakdown of each status")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("*")])]),_v(" "),_c('td',[_v("Organised CS Undergraduate")]),_v(" "),_c('td',[_v("view the interview dates for different internships applications")]),_v(" "),_c('td',[_v("I can update my schedule accordingly")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("*")])]),_v(" "),_c('td',[_v("Efficient CS Undergraduate")]),_v(" "),_c('td',[_v("view my most desired internship applications by favouriting them")]),_v(" "),_c('td',[_v("I can prioritize my time on checking up on these internship applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("*")])]),_v(" "),_c('td',[_v("Forgetful CS Undergraduate")]),_v(" "),_c('td',[_v("remind myself of acceptance deadline")]),_v(" "),_c('td',[_v("I will not miss the deadline to accept")])])])])])} +with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Priority")]),_v(" "),_c('th',[_v("As a …​")]),_v(" "),_c('th',[_v("I want to …​")]),_v(" "),_c('th',[_v("So that …​")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("list all the internship applications")]),_v(" "),_c('td',[_v("I can view all my past applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("Forgetful CS Undergraduate")]),_v(" "),_c('td',[_v("have a link to HireMe's help page")]),_v(" "),_c('td',[_v("I can see all the different commands that I can use")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("An efficient CS Undergraduate")]),_v(" "),_c('td',[_v("type the commands")]),_v(" "),_c('td',[_v("I do not have to lift my fingers off the keyboard")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("add an internship application")]),_v(" "),_c('td',[_v("I can add on to the records of all the internships I have applied to")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("delete an internship application")]),_v(" "),_c('td',[_v("I can remove invalid or irrelevant applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("save the internship application data locally")]),_v(" "),_c('td',[_v("I will not lose my data when I exit the application")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("load the internship from a saved file")]),_v(" "),_c('td',[_v("I can get back my data when I open the application")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("clear the list of internship application I have saved")]),_v(" "),_c('td',[_v("I can restart a new list in the next internship application cycle")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("find internship applications by company name")]),_v(" "),_c('td',[_v("I can quickly locate specific applications for review or updates")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("filter internship applications by status")]),_v(" "),_c('td',[_v("I can quickly view all applications of a specific status to follow up")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* * *")])]),_v(" "),_c('td',[_v("CS Undergraduate")]),_v(" "),_c('td',[_v("update the status of an internship application to accepted, pending, or rejected")]),_v(" "),_c('td',[_v("I can update the status of each application accurately")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* *")])]),_v(" "),_c('td',[_v("Meticulous CS Undergraduate")]),_v(" "),_c('td',[_v("sort the list of internship applications by date of application")]),_v(" "),_c('td',[_v("I can prioritize follow-ups with older applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("* *")])]),_v(" "),_c('td',[_v("Curious CS Undergraduate")]),_v(" "),_c('td',[_v("see a chart that summarises the statuses of all my applications")]),_v(" "),_c('td',[_v("I know know the breakdown of each status")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("*")])]),_v(" "),_c('td',[_v("Organised CS Undergraduate")]),_v(" "),_c('td',[_v("view the interview dates for different internships applications")]),_v(" "),_c('td',[_v("I can update my schedule accordingly")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("*")])]),_v(" "),_c('td',[_v("Efficient CS Undergraduate")]),_v(" "),_c('td',[_v("view my most desired internship applications by favouriting them")]),_v(" "),_c('td',[_v("I can prioritize my time on checking up on these internship applications")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("*")])]),_v(" "),_c('td',[_v("Forgetful CS Undergraduate")]),_v(" "),_c('td',[_v("remind myself of acceptance deadline")]),_v(" "),_c('td',[_v("I will not miss the deadline to accept")])])])])])} },function anonymous( ) { with(this){return _c('p',[_c('em',[_v("{More to be added}")])])} @@ -677,7 +680,7 @@ with(this){return _c('p',[_c('br'),_c('br')])} with(this){return _c('h3',{attrs:{"id":"launch"}},[_v("Launch"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#launch","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('ol',[_c('li',[_c('p',[_v("Initial launch")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Download the jar file and copy into an empty folder")])]),_v(" "),_c('li',[_c('p',[_v("Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.")])])])]),_v(" "),_c('li',[_c('p',[_v("Saving window preferences")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Resize the window to an optimum size. Move the window to a different location. Close the window.")])]),_v(" "),_c('li',[_c('p',[_v("Re-launch the app by double-clicking the jar file."),_c('br'),_v("\nExpected: The most recent window size and location is retained.")])])])])])} +with(this){return _c('ol',[_c('li',[_c('p',[_v("Initial launch")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Download the jar file and copy into an empty folder")])]),_v(" "),_c('li',[_c('p',[_v("Run java -jar hireme.jar in a terminal. "),_c('br'),_v("\nExpected: Shows the GUI with a set of sample contacts. The window size may not be optimum.")])])])]),_v(" "),_c('li',[_c('p',[_v("Saving window preferences")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Resize the window to an optimum size. Move the window to a different location. Close the window.")])]),_v(" "),_c('li',[_c('p',[_v("Re-launch the app by running java -jar hireme.jar in a terminal."),_c('br'),_v("\nExpected: The most recent window size and location is retained.")])])])])])} },function anonymous( ) { with(this){return _c('p',[_c('br'),_c('br')])} @@ -794,9 +797,9 @@ with(this){return _c('h2',{attrs:{"id":"appendix-planned-enhancements"}},[_c('st with(this){return _c('p',[_v("The team consists of 5 members.\nGiven below are enhancements planned for future versions. "),_c('br')])} },function anonymous( ) { -with(this){return _c('ol',[_c('li',[_c('p',[_c('strong',[_v("Make 'Role' and 'Company Name' in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(" command less restrictive:")])]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The current validator is too restrictive on what is allowed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Role")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company Name")]),_v(". Valid roles such as: C++ Developer, C# Developer, R&D Specialist are currently flagged as invalid by the validator. Similarly, valid company names such as: A*STAR, SK-II, Yahoo!, John's Bakery are also flagged as invalid by the validator. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: We plan to loosen the restrictions for roles and company names by adjusting the regular expressions allowed. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: This allows the command to be more inclusive of the possible roles and company names in the real world. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Improve consistency in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" feature:")]),_v(" Currently, while we prevent special characters in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company Name")]),_v(" (such as ~`!@#),"),_c('br'),_v("\nwe did not prevent the same characters from being used as keywords for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" feature. This leads to an inconsistent user experience,\nsince these characters would never be found in company names. We plan to be more consistent,\nand check whether the keywords provided to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" command are valid characters that are allowed in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company Name")]),_v(". "),_c('br')])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Make error message for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(" command more specific:")]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The error message provided when the user inputs an invalid "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(" command is too generic.\nFor example, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/add n/Google r/SWE d/01/01/24")]),_v(" will provide an error message stating "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Invalid command format!")]),_v(". It does not provide additional information to the user,\non why the command is invalid. The error message could be more specific to state the email field is missing.\n"),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: We plan to improve the validator to be able to detect specifically why the command is invalid, and provide a more specific error message.\n"),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: In doing so, users will have a clearer idea on what they did wrong when they typed in the command and they will be able to easily fix the issue. This enables the users to have a more pleasant experience when using HireMe.\n"),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Improve UI to deal with long texts:")]),_v(" The current application does not allow the user to scroll the list displayed on the application.\nIf there is a very long text, the text will be cut off and the use would have to maximise the application's window in order to see the full text.\nWe plan to implement scroll bars within the list displayed in the application, to allow the user to scroll and see any long texts. "),_c('br')])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Improve the validator for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("email")])]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: Although the current email validator accepts most valid email addresses, there are still certain valid email addresses (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("faceb__k@fb.com.sg")]),_v(") that it might incorrectly flag out as invalid addresses. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: A fix for the email validator to accept valid emails with more combinations of special characters. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: Company emails with uncommon combinations of special characters in their email addresses will be considered invalid and hence, users will not be able to include such internship application in the HireMe tracking system. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("User confirmation for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command")]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command clears all internship applications without asking for user confirmation. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: HireMe to prompt the user for confirmation on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command. If the user confirms, then all internship applications will be cleared. Otherwise, no action will be taken and the internship applications remain. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: HireMe does not support any form of undo action and hence, there is no safety mechanism against accidental clearing of internship applications by the user. By having a confirmation, it ensures that "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" is only carried out deliberately. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Backup file for storage")]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: Internship applications data is stored in a single data file "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hireme.json")]),_v(". "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: A backup file that replicates the data in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hireme.json")]),_v(". "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: Having only a single data file to store internship applications data means having a single point of failure when the data in corrupted or lost. A backup file that synchronously replicates the data in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hireme.json")]),_v(" ensures data redundancy. "),_c('br'),_c('br')])])])])} +with(this){return _c('ol',[_c('li',[_c('p',[_c('strong',[_v("Make 'Role' and 'Company Name' in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(" command less restrictive:")])]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The current validator is too restrictive on what is allowed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Role")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company Name")]),_v(". Valid roles such as: C++ Developer, C# Developer, R&D Specialist are currently flagged as invalid by the validator. Similarly, valid company names such as: A*STAR, SK-II, Yahoo!, John's Bakery are also flagged as invalid by the validator. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: We plan to loosen the restrictions for roles and company names by adjusting the regular expressions allowed. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: This allows the command to be more inclusive of the possible roles and company names in the real world. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Improve consistency in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" feature:")]),_v(" Currently, while we prevent special characters in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company Name")]),_v(" (such as ~`!@#),"),_c('br'),_v("\nwe did not prevent the same characters from being used as keywords for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" feature. This leads to an inconsistent user experience,\nsince these characters would never be found in company names. We plan to be more consistent,\nand check whether the keywords provided to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" command are valid characters that are allowed in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company Name")]),_v(". "),_c('br')])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Make error message for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(" command more specific:")]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The error message provided when the user inputs an invalid "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(" command is too generic.\nFor example, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/add n/Google r/SWE d/01/01/24")]),_v(" will provide an error message stating "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Invalid command format!")]),_v(". It does not provide additional information to the user,\non why the command is invalid. The error message could be more specific to state the email field is missing.\n"),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: We plan to improve the validator to be able to detect specifically why the command is invalid, and provide a more specific error message.\n"),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: In doing so, users will have a clearer idea on what they did wrong when they typed in the command and they will be able to easily fix the issue. This enables the users to have a more pleasant experience when using HireMe.\n"),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Improve UI to deal with long texts:")]),_v(" "),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The current application does not allow the user to scroll horizontally across the internship application card. Hence, very long text will be cut off and use are unable to see the full text.")]),_v(" "),_c('li',[_v("Planned enhancement: We plan to allow horizontal scrolling for an internship application card when there are long texts.")]),_v(" "),_c('li',[_v("Justification: This lets the user see the full text in application.\n"),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Improve the validator for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("email")])]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: Although the current email validator accepts most valid email addresses, there are still certain valid email addresses (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("faceb__k@fb.com.sg")]),_v(") that it might incorrectly flag out as invalid addresses. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: A fix for the email validator to accept valid emails with more combinations of special characters. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: Company emails with uncommon combinations of special characters in their email addresses will be considered invalid and hence, users will not be able to include such internship application in the HireMe tracking system. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("User confirmation for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command")]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command clears all internship applications without asking for user confirmation. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: HireMe to prompt the user for confirmation on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command. If the user confirms, then all internship applications will be cleared. Otherwise, no action will be taken and the internship applications remain. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: HireMe does not support any form of undo action and hence, there is no safety mechanism against accidental clearing of internship applications by the user. By having a confirmation, it ensures that "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" is only carried out deliberately. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Backup file for storage")]),_v(" "),_c('br'),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: Internship applications data is stored in a single data file "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hireme.json")]),_v(". "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: A backup file that replicates the data in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hireme.json")]),_v(". "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: Having only a single data file to store internship applications data means having a single point of failure when the data in corrupted or lost. A backup file that synchronously replicates the data in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hireme.json")]),_v(" ensures data redundancy. "),_c('br'),_c('br')])])])])} },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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index f2a3954f726..62b993886b2 100644 --- a/Documentation.html +++ b/Documentation.html @@ -14,7 +14,7 @@

    Documentation Guide

    Style guidance:

    Converting to PDF

    +

    Documentation Guide

    Style guidance:

    Converting to PDF

    diff --git a/Documentation.page-vue-render.js b/Documentation.page-vue-render.js index 31245b78f74..6dec64ad72d 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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index 563857c332f..702311073be 100644 --- a/Logging.html +++ b/Logging.html @@ -14,7 +14,7 @@

    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.
    +

    Logging guide

    diff --git a/Logging.page-vue-render.js b/Logging.page-vue-render.js index 406abdd73e8..1733c3ecc83 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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index 462905651f1..045ad7d7291 100644 --- a/SettingUp.html +++ b/SettingUp.html @@ -19,7 +19,7 @@ Note: Importing a Gradle project is slightly different from importing a normal Java project.
  • Verify the setup:
    1. Run the seedu.hireme.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.

    +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.

  • 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.

  • 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.

    • diff --git a/SettingUp.page-vue-render.js b/SettingUp.page-vue-render.js index 353086bb0e0..afd3bff0f07 100644 --- a/SettingUp.page-vue-render.js +++ b/SettingUp.page-vue-render.js @@ -38,6 +38,6 @@ with(this){return _c('li',[_c('p',[_c('strong',[_v("Set up CI")])]),_v(" "),_c(' with(this){return _c('li',[_c('p',[_c('strong',[_v("Learn the design")])]),_v(" "),_c('p',[_v("When you are ready to start coding, we recommend that you get some sense of the overall design by reading about "),_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#architecture"}},[_v("AddressBook’s architecture")]),_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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index 74a8c6e9481..f26129a3610 100644 --- a/Testing.html +++ b/Testing.html @@ -18,7 +18,7 @@ test class, or a test and choose Run 'ABC'
  • Method 2: Using Gradle

    • 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.hireme.commons.util.StringUtilTest
    2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.hireme.storage.StorageManagerTest
    3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how they are connected together.
      -e.g. seedu.hireme.logic.LogicManagerTest
    +e.g. seedu.hireme.logic.LogicManagerTest diff --git a/Testing.page-vue-render.js b/Testing.page-vue-render.js index 2134937dc96..469b793d7fd 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.hireme.commons.util.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.hireme.storage.StorageManagerTest")])]),_v(" "),_c('li',[_c('em',[_v("Hybrids of unit and integration tests")]),_v(". These test are checking multiple code units as well as how they are connected together."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seedu.hireme.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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index 9ffd2ffc114..4b604d7f1ad 100644 --- a/UserGuide.html +++ b/UserGuide.html @@ -45,7 +45,7 @@

    Q7: What is considered a valid email address format?

    Ans: If you have an existing email address account, it will be allowed by HireMe. You can check here.

    Troubleshooting

    If you are facing problems while setting up or using HireMe, we want to help you. This section covers some of the common problems and ways to solve them. If you need further help, you can reach out to us through our email hireme@gmail.com.

    HireMe application setup failed

    Check that you have the hireme.jar in the correct folder and copied the correct file path into the terminal. Check that you have Java 17 or above downloaded in your computer. Follow the correct set of instructions based on your computer system, see Part 2 of setting up.

    Getting errors when using the commands

    Check that you have the typed the correct command format. Check that you have included all necessary parameters. Check that you have used valid inputs (refer to each command for valid inputs). -

    Unable to see the full text on the screen

    Try opening the window to full screen or scroll to view the full text. Avoid inputting texts that are too lengthy.

    Command summary

    Action Format, Examples
    Help /help
    Add /add n/COMPANY_NAME r/ROLE e/EMAIL d/DATE
    e.g. /add n/Google r/Software Engineer Intern e/google@gmail.com d/16/09/24
    List /list
    Delete /delete INDEX
    e.g. /delete 3
    Find /find KEYWORD [ADDITIONAL_KEYWORDS]
    e.g. /find Google Facebook
    Accept /accept INDEX
    e.g. /accept 2
    Pending /pending INDEX
    e.g. /pending 3
    Reject /reject INDEX
    e.g. /reject 1
    Filter /filter STATUS
    e.g. /filter pending
    Sort /sort ORDER
    e.g. /sort earliest
    Clear /clear
    Chart /chart
    Exit /exit

    Glossary

    Term Definition
    Action The task carried out by the HireMe application such as Add, Delete, Update entries.
    Alphanumeric Consisting of both letters and numbers.
    Application Status - PENDING: The internship application is currently in progress.
    - REJECTED: The user has rejected or been rejected from this internship application.
    - ACCEPTED: The user has accepted the offer for this internship.
    Command The input the user types into the HireMe application’s command bar to carry out a particular action.
    Command Bar The input bar at the top of the HireMe application which allows users to type in a string command.
    Company Email The email of the company that the user is applying for an internship role at.
    Company Name The name of the company that the user is applying for an internship role at.
    Command Line Interface (CLI) An interface that the user interacts with by typing text commands instead of using a mouse to click on buttons or icons.
    Filepath The location through which a file can be accessed in a file system.
    Graphical User Interface (GUI) An interface that the user interacts with using visual elements like buttons, icons and windows.
    Index The application number of the internship application displayed in the list.
    Java A programming language for coding applications, websites and other software.
    Java Archive (Jar) A file format used to package multiple files into one file for distribution.
    JavaScript Object Notation (JSON) A readable format to represent structured data, which is commonly used for web applications.
    Order The order that the user would like the list to be in, based on the date of application.
    Parameter The details needed to perform specific commands. (e.g. Add command has a parameter for company name)
    Role The role of the internship the user applied for.
    Terminal A text-based interface for interacting with a computer. It allows users to execute commands and view the results.

    Acknowledgements

    We would like to acknowledge the following contributions:

    We started with a general AB3 user guide template and adapted it to the functional requirements of HireMe. We also used MarkBind which is a third party library to generate a dynamic user guide website from Markdown text.

    AI tools such as ChatGPT were also used to check for grammatical errors.

    +

    Unable to see the full text on the screen

    Try opening the window to full screen or scroll to view the full text. Avoid inputting texts that are too lengthy.

    Command summary

    Action Format, Examples
    Help /help
    Add /add n/COMPANY_NAME r/ROLE e/EMAIL d/DATE
    e.g. /add n/Google r/Software Engineer Intern e/google@gmail.com d/16/09/24
    List /list
    Delete /delete INDEX
    e.g. /delete 3
    Find /find KEYWORD [ADDITIONAL_KEYWORDS]
    e.g. /find Google Facebook
    Accept /accept INDEX
    e.g. /accept 2
    Pending /pending INDEX
    e.g. /pending 3
    Reject /reject INDEX
    e.g. /reject 1
    Filter /filter STATUS
    e.g. /filter pending
    Sort /sort ORDER
    e.g. /sort earliest
    Clear /clear
    Chart /chart
    Exit /exit

    Glossary

    Term Definition
    Action The task carried out by the HireMe application such as Add, Delete, Update entries.
    Alphanumeric Consisting of both letters and numbers.
    Application Status - PENDING: The internship application is currently in progress.
    - REJECTED: The user has rejected or been rejected from this internship application.
    - ACCEPTED: The user has accepted the offer for this internship.
    Command The input the user types into the HireMe application’s command bar to carry out a particular action.
    Command Bar The input bar at the top of the HireMe application which allows users to type in a string command.
    Company Email The email of the company that the user is applying for an internship role at.
    Company Name The name of the company that the user is applying for an internship role at.
    Command Line Interface (CLI) An interface that the user interacts with by typing text commands instead of using a mouse to click on buttons or icons.
    Filepath The location through which a file can be accessed in a file system.
    Graphical User Interface (GUI) An interface that the user interacts with using visual elements like buttons, icons and windows.
    Index The application number of the internship application displayed in the list.
    Java A programming language for coding applications, websites and other software.
    Java Archive (Jar) A file format used to package multiple files into one file for distribution.
    JavaScript Object Notation (JSON) A readable format to represent structured data, which is commonly used for web applications.
    Order The order that the user would like the list to be in, based on the date of application.
    Parameter The details needed to perform specific commands. (e.g. Add command has a parameter for company name)
    Role The role of the internship the user applied for.
    Terminal A text-based interface for interacting with a computer. It allows users to execute commands and view the results.

    Acknowledgements

    We would like to acknowledge the following contributions:

    We started with a general AB3 user guide template and adapted it to the functional requirements of HireMe. We also used MarkBind which is a third party library to generate a dynamic user guide website from Markdown text.

    AI tools such as ChatGPT were also used to check for grammatical errors.

    diff --git a/UserGuide.page-vue-render.js b/UserGuide.page-vue-render.js index 800323bb5f9..23bf6e209c4 100644 --- a/UserGuide.page-vue-render.js +++ b/UserGuide.page-vue-render.js @@ -392,6 +392,6 @@ with(this){return _c('h2',{attrs:{"id":"acknowledgements"}},[_v("Acknowledgement with(this){return _c('p',[_v("We started with a general "),_c('a',{attrs:{"href":"https://se-education.org/addressbook-level3/UserGuide.html"}},[_v("AB3 user guide")]),_v(" template and adapted it to the functional requirements of HireMe. We also used "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind")]),_v(" which is a third party library to generate a dynamic user guide website from Markdown text.")])} },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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index 3943a715dc6..2dc0096a78c 100644 --- a/index.html +++ b/index.html @@ -14,7 +14,7 @@

    icon HireMe

    CI Status codecov

    Ui

    HireMe is a free desktop application designed to make tracking internship applications easy, fast, and accessible for undergraduate students. While it has a GUI (Graphical User Interface), most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    +

    icon HireMe

    CI Status codecov

    Ui

    HireMe is a free desktop application designed to make tracking internship applications easy, fast, and accessible for undergraduate students. While it has a GUI (Graphical User Interface), most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    diff --git a/index.page-vue-render.js b/index.page-vue-render.js index 18546f3eba0..29ba40b3b88 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":"hireme"}},[_c('a',{attrs:{"href":"/tp/images/hireme_logo.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/hireme_logo.png","alt":"icon"}})]),_v(" HireMe"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#hireme","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/actions"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://github.com/AY2425S1-CS2103T-W09-3/tp/workflows/Java%20CI/badge.svg","alt":"CI Status"}})]),_v(" "),_c('a',{attrs:{"href":"https://codecov.io/gh/AY2425S1-CS2103T-W09-3/tp"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://codecov.io/gh/AY2425S1-CS2103T-W09-3/tp/graph/badge.svg?token=JZ0L5L0Q7Y","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("HireMe is a free desktop application designed to make tracking internship applications "),_c('em',[_v("easy")]),_v(", "),_c('em',[_v("fast")]),_v(", and "),_c('em',[_v("accessible")]),_v(" for undergraduate students.")]),_v(" While it has a GUI (Graphical User Interface), most of the user interactions happen using a CLI (Command Line Interface).")]),_v(" "),_c('ul',[_c('li',[_v("If you are interested in using HireMe, 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 HireMe, the "),_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_c('strong',[_v("Developer Guide")])]),_v(" is a good place 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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/choaticman.html b/team/choaticman.html index dfec2406e86..a349c3fef26 100644 --- a/team/choaticman.html +++ b/team/choaticman.html @@ -16,7 +16,7 @@ Search

    Project: HireMe

    HireMe is a desktop application for managing internship applications, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). -If you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.

    Given below are my contributions to the project.

    +If you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.

    Given below are my contributions to the project.

    diff --git a/team/choaticman.page-vue-render.js b/team/choaticman.page-vue-render.js index e3c8fba0ba8..ae96d16b8ef 100644 --- a/team/choaticman.page-vue-render.js +++ b/team/choaticman.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-hireme"}},[_v("Project: HireMe"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-hireme","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("HireMe is a "),_c('strong',[_v("desktop application for managing internship applications, optimized for use via a Command Line Interface")]),_v(" (CLI)\nwhile still having the benefits of a Graphical User Interface (GUI).\nIf you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Statuses for internship applications.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: allows the user to mark internship applications as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PENDING")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ACCEPTED")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REJECTED")]),_v(".")]),_v(" "),_c('li',[_v("Justification: This feature improves the product significantly because a user should be able to track the outcomes of the applications.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": UI for internship applications' statuses.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: allows the user to see the statuses of the internship applications. The statuses are coloured coded for easier identification.")]),_v(" "),_c('li',[_v("Justification: This feature improves the product significantly because a user should be able to see the statuses of the applications easily.")]),_v(" "),_c('li',[_v("Highlights: Any modification to any status will be reflected in real time in the UI.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2425s1.github.io/tp-dashboard/?search=choaticman&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-09-20&tabOpen=true&tabType=authorship&tabAuthor=choaticman&tabRepo=AY2425S1-CS2103T-W09-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false"}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Managed releases "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.3")]),_v(" - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.5rc")]),_v(" (3 releases) on GitHub")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Wrote tests for InternshipApplication Model (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/100"}},[_v("#100")]),_v(").")]),_v(" "),_c('li',[_v("Wrote tests for existing and new features (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/69"}},[_v("#69")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/73"}},[_v("#73")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/115"}},[_v("#115")]),_v(").")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("User Guide:")]),_v(" "),_c('ul',[_c('li',[_v("Updated documentation for the features (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/180"}},[_v("#108")]),_v(").")]),_v(" "),_c('li',[_v("Included FAQ segment (Pull request"),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/189"}},[_v("#189")]),_v(").")])])]),_v(" "),_c('li',[_c('p',[_v("Developer Guide:")]),_v(" "),_c('ul',[_c('li',[_v("Added implementation details of the application Architecture as well as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/find")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/list")]),_v(" feature (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/129"}},[_v("#129")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/201"}},[_v("#201")]),_v(").")]),_v(" "),_c('li',[_v("Added user stories (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/29"}},[_v("#29")]),_v(").")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("PRs reviewed with non-trivial review comments (example: "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/110"}},[_v("#110")]),_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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/raghava-chittidi.html b/team/raghava-chittidi.html index 1131fde70f5..c0b770bdf38 100644 --- a/team/raghava-chittidi.html +++ b/team/raghava-chittidi.html @@ -18,7 +18,7 @@ while still having the benefits of a Graphical User Interface (GUI). If you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.

    Given below are my contributions to the project.

    +

  • Community:

    • diff --git a/team/raghava-chittidi.page-vue-render.js b/team/raghava-chittidi.page-vue-render.js index fda1f96657e..9426efd0900 100644 --- a/team/raghava-chittidi.page-vue-render.js +++ b/team/raghava-chittidi.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-hireme"}},[_v("Project: HireMe"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-hireme","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("HireMe is a "),_c('strong',[_v("desktop application for managing internship applications, optimized for use via a Command Line Interface")]),_v(" (CLI)\nwhile still having the benefits of a Graphical User Interface (GUI).\nIf you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added a delete command which deletes an internship application from the list by index.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: Deletes the internship application at the specified index.")]),_v(" "),_c('li',[_v("Justification: This feature is necessary for the HireMe application to work properly as users would want to delete internship applications that they no longer want to track.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added the ability sort the list of internship applications.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: Allows the user to sort the list in ascending or descending order, by date of application.")]),_v(" "),_c('li',[_v("Justification: This feature is a nice-to-have as it allows users to sort the list and follow up on any old internship applications where the company has not gotten back to them.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2425s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-09-20&tabOpen=true&tabType=authorship&tabAuthor=Raghava-Chittidi&tabRepo=AY2425S1-CS2103T-W09-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false"}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Managed release "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.4")]),_v(" (1 release) on GitHub")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Added defensive programming through the use of assertions and exceptions.")]),_v(" "),_c('li',[_v("Added logging to enable better debugging in the future.")]),_v(" "),_c('li',[_v("Ensured error messages are consistent for all commands to reduce ambiguity.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Testing")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Added extensive test cases for model and parser packages.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("User Guide:\n"),_c('ul',[_c('li',[_v("Added documentation for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" feature")]),_v(" "),_c('li',[_v("Added documentation for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort")]),_v(" feature")])])]),_v(" "),_c('li',[_v("Developer Guide:\n"),_c('ul',[_c('li',[_v("Added implementation details of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort")]),_v(" features.")]),_v(" "),_c('li',[_v("Added sequence diagrams for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort")]),_v(" features.")]),_v(" "),_c('li',[_v("Added user stories for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort")]),_v(" features.")]),_v(" "),_c('li',[_v("Added use cases for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort")]),_v(" features.")]),_v(" "),_c('li',[_v("Added terms into glossary.")]),_v(" "),_c('li',[_v("Added Non-Functional Requirements (NFRs).")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("PRs reviewed (with non-trivial review comments): "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/43"}},[_v("#43")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/57"}},[_v("#19")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/105"}},[_v("#105")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/188"}},[_v("#188")])])])])])])} },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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/woke02.html b/team/woke02.html index c1be87e236e..1d5f876472a 100644 --- a/team/woke02.html +++ b/team/woke02.html @@ -16,7 +16,7 @@ Search

    Project: HireMe

    HireMe is a desktop application for managing internship applications, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, HireMe can help you manage your internship tracking tasks faster than traditional GUI apps.

    Given below are my contributions to the project.

    + diff --git a/team/woke02.page-vue-render.js b/team/woke02.page-vue-render.js index 47442047af2..b7657d49f18 100644 --- a/team/woke02.page-vue-render.js +++ b/team/woke02.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-hireme"}},[_v("Project: HireMe"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-hireme","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("HireMe is a "),_c('strong',[_v("desktop application for managing internship applications, optimized for use via a Command Line Interface")]),_v(" (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, HireMe can help you manage your internship tracking tasks faster than traditional GUI apps.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Architected and implemented a robust model schema, creating foundational model classes essential for application functionality.")]),_v(" "),_c('ul',[_c('li',[_v("Details: Developed critical model classes, including "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Email")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("InternshipApplication")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Name")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Role")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Status")]),_v(", which serve as the building blocks for the entire model structure.")]),_v(" "),_c('li',[_v("Justification: These classes establish a scalable, clear, and maintainable framework, streamlining data flow and ensuring efficient data management across the application. This structured approach optimizes performance and paves the way for future feature expansion with minimal refactoring.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added a status command to update the status of an internship application.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: Allows users to update the status of an internship application to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ACCEPTED")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PENDING")]),_v(", or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REJECTED")]),_v(".")]),_v(" "),_c('li',[_v("Justification: This feature is crucial for tracking the current stage of each application, enabling users to keep organized records.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2425s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-09-20&tabOpen=true&tabType=authorship&tabAuthor=woke02&tabRepo=AY2425S1-CS2103T-W09-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false"}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Managed releases "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.3")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.5")]),_v(" on GitHub, overseeing feature completeness and stability.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Added logging to improve future debugging processes.")]),_v(" "),_c('li',[_v("Ensured error messages are consistent across models to reduce ambiguity.")]),_v(" "),_c('li',[_v("Enhanced defensive programming by using assertions and exceptions for increased robustness.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Testing")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Added extensive test cases for the models and certain parser commands to ensure code reliability.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('strong',[_v("User Guide")]),_v(":\n"),_c('ul',[_c('li',[_v("Documented the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("status")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(" features.")]),_v(" "),_c('li',[_v("Documented on how to use the user guide")])])]),_v(" "),_c('li',[_c('strong',[_v("Developer Guide")]),_v(":\n"),_c('ul',[_c('li',[_v("Added implementation details for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("status")]),_v(" feature.")]),_v(" "),_c('li',[_v("Created sequence diagrams for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("status")]),_v(" features.")]),_v(" "),_c('li',[_v("Added user stories for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("status")]),_v(" features.")]),_v(" "),_c('li',[_v("Added use cases for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("status")]),_v(" features.")]),_v(" "),_c('li',[_v("Created an activity diagram for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("status")]),_v(" feature.")])])])])])])])} },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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/xueting.html b/team/xueting.html index 73fa6f76ca9..3fb9a98915a 100644 --- a/team/xueting.html +++ b/team/xueting.html @@ -16,7 +16,7 @@ Search

    Project: HireMe

    HireMe is a desktop application for managing internship applications, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). -If you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.

    Given below are my contributions to the project.

    +If you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.

    Given below are my contributions to the project.

    diff --git a/team/xueting.page-vue-render.js b/team/xueting.page-vue-render.js index 950d8caa479..4030104f2fb 100644 --- a/team/xueting.page-vue-render.js +++ b/team/xueting.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-hireme"}},[_v("Project: HireMe"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-hireme","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("HireMe is a "),_c('strong',[_v("desktop application for managing internship applications, optimized for use via a Command Line Interface")]),_v(" (CLI)\nwhile still having the benefits of a Graphical User Interface (GUI).\nIf you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": List all internship applications.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: Allows the user to view all internship applications they had added in HireMe.")]),_v(" "),_c('li',[_v("Justification: This is a necessary feature for the HireMe application to reset the searches and filters and view the original list of internship applications.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Filter through all internship applications by status.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: Allows the user to filter through all internship applications by status of pending, accepted or rejected.")]),_v(" "),_c('li',[_v("Justification: This feature is nice-to-have as it allows users to easily find a group of internship application of specified status.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2425s1.github.io/tp-dashboard/?search=&sort=totalCommits%20dsc&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-09-20&tabOpen=true&tabType=authorship&tabAuthor=snowstopxt&tabRepo=AY2425S1-CS2103T-W09-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false"}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Added labels to repository to use in PRs and Issues.")]),_v(" "),_c('li',[_v("Wrote meeting minutes for weekly meetings in internal project notes.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Updated the GUI color scheme (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/185"}},[_v("#185")]),_v(")")]),_v(" "),_c('li',[_v("Updated the application with new logo (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/222"}},[_v("#222")]),_v(")")]),_v(" "),_c('li',[_v("Fixed checkstyle errors (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/87"}},[_v("#87")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("User Guide:")]),_v(" "),_c('ul',[_c('li',[_v("Added documentation for the features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/126/files"}},[_v("#126")]),_v(")")]),_v(" "),_c('li',[_v("Improved introduction section and added table of contents (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/200"}},[_v("#200")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_v("Developer Guide:")]),_v(" "),_c('ul',[_c('li',[_v("Added implementation details and sequence diagram of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter")]),_v(" feature (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/126/files"}},[_v("#126")]),_v(")")]),_v(" "),_c('li',[_v("Tweak sequence diagram to storage (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/126/files"}},[_v("#126")]),_v(")")]),_v(" "),_c('li',[_v("Added table of contents to introduction section (Pull request "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/200"}},[_v("#200")]),_v(")")]),_v(" "),_c('li',[_v("Added use cases for exit")]),_v(" "),_c('li',[_v("Added index to glossary")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("PRs reviewed (with non-trivial review comments): "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/103"}},[_v("#103")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/115"}},[_v("#115")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/135"}},[_v("#135")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W09-3/tp/pull/181"}},[_v("#181")])])])])])])} },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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/zwezeya.html b/team/zwezeya.html index df5a4b5dd17..73094f9aa9c 100644 --- a/team/zwezeya.html +++ b/team/zwezeya.html @@ -18,7 +18,7 @@ while still having the benefits of a Graphical User Interface (GUI). If you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.

    Given below are my contributions to the project.

    +

  • Community:

    • diff --git a/team/zwezeya.page-vue-render.js b/team/zwezeya.page-vue-render.js index c6e73220c2d..0496dce9ff1 100644 --- a/team/zwezeya.page-vue-render.js +++ b/team/zwezeya.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-hireme"}},[_v("Project: HireMe"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-hireme","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("HireMe is a "),_c('strong',[_v("desktop application for managing internship applications, optimized for use via a Command Line Interface")]),_v(" (CLI)\nwhile still having the benefits of a Graphical User Interface (GUI).\nIf you can type fast, HireMe can get your internship tracking tasks done faster than traditional GUI apps.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added the ability add an internship application entry.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: Allows the user to add a new internship application entry.")]),_v(" "),_c('li',[_v("Justification: This feature is necessary for the functionality of HireMe as users need to be able to add internship applications so that they can track them.")]),_v(" "),_c('li',[_v("Highlights: This feature addresses the compatibility issues of the old AddressBook with the functional requirements of HireMe.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added a chart command which summarises the statuses of all internship applications")]),_v(" "),_c('ul',[_c('li',[_v("What it does: Displays a pie chart that gives insights to the statuses of all internship applications")]),_v(" "),_c('li',[_v("Justification: This feature gives a visual representation of the statuses of all internship applications which makes HireMe more interactive.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2425s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-09-20&tabOpen=true&tabType=authorship&tabAuthor=ZweZeya&tabRepo=AY2425S1-CS2103T-W09-3%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false"}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Decoupled the validation from the model by creating an abstract class "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Validator")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("User Guide:\n"),_c('ul',[_c('li',[_v("Added documentation for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("chart")]),_v(" feature")])])]),_v(" "),_c('li',[_v("Developer Guide:\n"),_c('ul',[_c('li',[_v("Added implementation details of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("chart")]),_v(" features.")]),_v(" "),_c('li',[_v("Added sequence diagrams for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("chart")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(" features.")]),_v(" "),_c('li',[_v("Added use cases for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("chart")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(" features.")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Reviewed PRs")])])])])])} },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 Tue, 12 Nov 2024, 1:40:48 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 Tue, 12 Nov 2024, 1:40:53 GMT+8]")])])])} }]; \ No newline at end of file