diff --git a/AboutUs.html b/AboutUs.html index 6e868eead4a..5e7e14ba073 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 8a2fb3ab655..268ac110e75 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index c3ad33da362..53314d670e1 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 80949b55dcd..13d745e6c59 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index e6f8fd78379..4aa984314df 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 3e4d0573381..4ff57901154 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index 8b052a8ff61..ecf687945b6 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -47,7 +47,7 @@



    System: HireMe application

    Use Case: UC10 - Filter internship applications by status

    Actor: User

    MSS (Main Success Scenario)

    1. The user provides a status to filter internship applications.

    2. HireMe shows all internship applications with the given status.

      Use case ends.

    Extensions



    System: HireMe application

    Use Case: UC11 - Clear all internship applications

    Actor: User

    MSS (Main Success Scenario)

    1. The user requests to clear all internship applications.

    2. HireMe clears all internship applications.

      Use case ends.

    Extensions



    System: HireMe application

    Use Case: UC12 - Exit HireMe application

    Actor: User

    MSS (Main Success Scenario)

    1. The user requests to exit the application.

    2. HireMe application closes and auto-saves the file.

      Use case ends.

    Extensions



    Non-Functional Requirements

    1. Performance: The application should respond to user actions within two seconds.
    2. Scalability: The application should handle at least 500 internship applications without any performance issues (e.g., lag or slowness).
    3. Cross-Platform Compatibility: The application should run on any operating system that has Java 17 installed.
    4. User Accessibility: The system should be usable by a novice with no prior experience using a CLI application, without much difficulty.
    5. Data Persistence: The application should ensure that data persists after the user closes the application.
    6. Data Integrity: Upon reopening the application, the loaded data should be identical to the last saved state and should not be volatile.



    Glossary

    Appendix: Instructions for manual testing

    Given below are instructions to test the app manually.

    Note: These instructions only provide a starting point for testers to work on; +

    • 1a1. HireMe shows an error message.

      Use case ends.



    Non-Functional Requirements

    1. Performance: The application should respond to user actions within two seconds.
    2. Reliability: The application should be able to perform effectively over time without errors or failures.
    3. Scalability: The application should handle at least 500 internship applications without any performance issues (e.g., lag or slowness).
    4. Cross-Platform Compatibility: The application should run on any operating system that has Java 17 installed.
    5. User Accessibility: The application should be usable by a novice with no prior experience using a CLI application, without much difficulty.
    6. Maintainability: The application should log useful information together with any errors that occur. The logs should be easily accessible to enable easier debugging and monitoring.
    7. Data Persistence: The application should ensure that data persists after the user closes the application.
    8. Data Integrity: Upon reopening the application, the loaded data should be identical to the last saved state and should not be volatile.
    9. Efficiency: The application should not use too much memory to prevent the user's computer from slowing down when using our application
    10. Documentation: The application should be well documented for users, which include command-line operations usages, as well as support for installing and troubleshooting. The code base should be well documented for future developers, allowing them to maintain, debug, test, and scale the system easily.
    11. Testability: The application's core features should be covered by integration and unit tests. Instructions should be included on how to conduct manual testing.
    12. Stability: The application should be able to recover from errors. It should not be crashing or losing data.



    Glossary

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

    • Action: The task carried out by the HireMe application such as Add, Delete, Update entries.

    • Command Line Interface (CLI): The user interacts with the computer by typing text commands instead of using a mouse to click on buttons or icons. As if giving instructions to execute a desired action.

    • Command: The string 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.

    • Graphical User Interface (GUI): The user interacts with the computer using visual elements like buttons, icons and windows.

    • Role: The role of the internship the user applied for.

    • Index: The index of the internship application displayed in the list.

    Appendix: Instructions for manual testing

    Given below are instructions to test the app manually.

    Note: These instructions only provide a starting point for testers to work on; testers are expected to do more exploratory testing.



    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
        @@ -116,7 +116,7 @@ For example, when the Java application is in full screen, /help or /chart will open up a help or a chart window respectively. Closing the popup window when the application is in full screen will cause the entire Java application to crash.

      3. Planned enhancement: We plan to improve by ensuring that the help and chart displays open on the main window of the application instead of as a popup. Users can then go back to the list by typing /list.

      4. Justification: This ensures that the application will not suddenly crash when the user is trying to use it for a smoother user experience. -

    [Powered by MarkBind 5.5.3, generated on Tue, 12 Nov 2024, 3:04:42 GMT+8]
    +

    diff --git a/DeveloperGuide.page-vue-render.js b/DeveloperGuide.page-vue-render.js index 0f532a0d0ee..109bf0b9e7a 100644 --- a/DeveloperGuide.page-vue-render.js +++ b/DeveloperGuide.page-vue-render.js @@ -647,7 +647,7 @@ with(this){return _c('p',[_c('br'),_c('br')])} with(this){return _c('h3',{attrs:{"id":"non-functional-requirements"}},[_v("Non-Functional Requirements"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#non-functional-requirements","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('ol',[_c('li',[_c('strong',[_v("Performance")]),_v(": The application should respond to user actions within "),_c('strong',[_v("two seconds")]),_v(".")]),_v(" "),_c('li',[_c('strong',[_v("Scalability")]),_v(": The application should handle "),_c('strong',[_v("at least 500 internship applications")]),_v(" without any performance issues (e.g., lag or slowness).")]),_v(" "),_c('li',[_c('strong',[_v("Cross-Platform Compatibility")]),_v(": The application should run on any operating system that has "),_c('strong',[_v("Java 17")]),_v(" installed.")]),_v(" "),_c('li',[_c('strong',[_v("User Accessibility")]),_v(": The system should be usable by a "),_c('strong',[_v("novice")]),_v(" with no prior experience using a CLI application, without much difficulty.")]),_v(" "),_c('li',[_c('strong',[_v("Data Persistence")]),_v(": The application should ensure that data "),_c('strong',[_v("persists")]),_v(" after the user closes the application.")]),_v(" "),_c('li',[_c('strong',[_v("Data Integrity")]),_v(": Upon reopening the application, the "),_c('strong',[_v("loaded data")]),_v(" should be identical to the "),_c('strong',[_v("last saved state")]),_v(" and should not be volatile.")])])} +with(this){return _c('ol',[_c('li',[_c('strong',[_v("Performance")]),_v(": The application should respond to user actions within "),_c('strong',[_v("two seconds")]),_v(".")]),_v(" "),_c('li',[_c('strong',[_v("Reliability")]),_v(": The application should be able to "),_c('strong',[_v("perform effectively")]),_v(" over time without errors or failures.")]),_v(" "),_c('li',[_c('strong',[_v("Scalability")]),_v(": The application should handle "),_c('strong',[_v("at least 500 internship applications")]),_v(" without any performance issues (e.g., lag or slowness).")]),_v(" "),_c('li',[_c('strong',[_v("Cross-Platform Compatibility")]),_v(": The application should run on any operating system that has "),_c('strong',[_v("Java 17")]),_v(" installed.")]),_v(" "),_c('li',[_c('strong',[_v("User Accessibility")]),_v(": The application should be usable by a "),_c('strong',[_v("novice")]),_v(" with no prior experience using a CLI application, without much difficulty.")]),_v(" "),_c('li',[_c('strong',[_v("Maintainability")]),_v(": The application should log useful information together with any errors that occur. The logs should be "),_c('strong',[_v("easily accessible")]),_v(" to enable easier debugging and monitoring.")]),_v(" "),_c('li',[_c('strong',[_v("Data Persistence")]),_v(": The application should ensure that data "),_c('strong',[_v("persists")]),_v(" after the user closes the application.")]),_v(" "),_c('li',[_c('strong',[_v("Data Integrity")]),_v(": Upon reopening the application, the "),_c('strong',[_v("loaded data")]),_v(" should be identical to the "),_c('strong',[_v("last saved state")]),_v(" and should not be volatile.")]),_v(" "),_c('li',[_c('strong',[_v("Efficiency")]),_v(": The application "),_c('strong',[_v("should not use too much memory")]),_v(" to prevent the user's computer from slowing down when using our application")]),_v(" "),_c('li',[_c('strong',[_v("Documentation")]),_v(": The application should be "),_c('strong',[_v("well documented")]),_v(" for users, which include command-line operations usages, as well as support for installing and troubleshooting. The code base should be well documented for future developers, allowing them to maintain, debug, test, and scale the system easily.")]),_v(" "),_c('li',[_c('strong',[_v("Testability")]),_v(": The application's core features should be covered by "),_c('strong',[_v("integration and unit tests")]),_v(". Instructions should be included on how to conduct "),_c('strong',[_v("manual testing")]),_v(".")]),_v(" "),_c('li',[_c('strong',[_v("Stability")]),_v(": The application should be able to "),_c('strong',[_v("recover from errors")]),_v(". It should not be crashing or losing data.")])])} },function anonymous( ) { with(this){return _c('p',[_c('br'),_c('br')])} @@ -788,6 +788,6 @@ with(this){return _c('p',[_v("The team consists of 5 members.\nGiven below are e 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(" "),_c('ul',[_c('li',[_v("Current behaviour: The find feature currently allows special characters (e.g., ~`!@#) to be used as keywords, despite these characters being disallowed in Company Name. This inconsistency can lead to a confusing user experience, as searches with these special characters will not yield any results. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: Implement validation in the find feature to restrict keywords to only valid characters that are allowed in Company Name. This will ensure that users can only search using characters that are present in actual company names. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: By enforcing consistency between allowed characters in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Company Name")]),_v(" and the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" feature, we improve the user experience by preventing ineffective searches and aligning expectations for valid search terms. "),_c('br'),_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('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('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. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: We plan to allow horizontal scrolling for an internship application card when there are long texts. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: This lets the user see the full text in application. "),_c('br'),_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('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('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("Improve error messaging for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("status")]),_v(" commands")])]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/accept")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/pending")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/reject")]),_v(" commands currently return the same generic error message when there’s an error, despite each command serving a distinct purpose. This shared error message does not provide clarity on which specific command failed, potentially confusing the user. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: Separate error messages for each command ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/accept")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/pending")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/reject")]),_v(") within the status command to clarify which specific action encountered an error. This will help users understand and correct command-specific errors more effectively. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: By providing distinct error messages for each command, we improve the user experience by making error feedback more specific and actionable. Users will be able to identify errors related to each command easily, reducing potential confusion and enhancing usability. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Backup file for storage")])]),_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')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Improve chart UI for empty statuses")])]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: With multiple empty statuses (e.g. zero internship applications with "),_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("/"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REJECTED")]),_v("), only one of the status labels will be shown. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: Remove chart labels for empty statuses. "),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: This ensures a consistent and user-friendly chart view which makes it easier for users to interpret the chart. "),_c('br'),_c('br')])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Fix popup window crash when on full-screen")])]),_v(" "),_c('ul',[_c('li',[_v("Current behaviour: When the Java application is in full screen and the help or chart window popup is closed, the entire Java application crashes.\nFor example, when the Java application is in full screen, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/help")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/chart")]),_v(" will open up a help or a chart window respectively. Closing the popup window when the application is in full screen will cause the entire Java application to crash.\n"),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Planned enhancement: We plan to improve by ensuring that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("chart")]),_v(" displays open on the main window of the application instead of as a popup. Users can then go back to the list by typing "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/list")]),_v(".\n"),_c('br'),_c('br')]),_v(" "),_c('li',[_v("Justification: This ensures that the application will not suddenly crash when the user is trying to use it for a smoother user experience.\n"),_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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index 61a60032aba..6b1d950f770 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 1f53f3de504..6d81378fe31 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index 29bbd03f354..a558a473266 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 35023c7459b..ab4f89a3e61 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index 5877559a89b..10af0fd9003 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 32164e0a4de..d3cb8398b02 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index 83ecee3a5b2..63dece653f9 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 7e4ccaf5081..8a162421667 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index ecac081cce5..509ff90ee4a 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 4daabbb63d3..11c7d51c5d8 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index b62abb881e4..60e09c917cb 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 afbc797fc8a..308fa13f17a 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/choaticman.html b/team/choaticman.html index 7a50cdfcb68..4796f24daf3 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 e4046a3fb23..0574e390345 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/raghava-chittidi.html b/team/raghava-chittidi.html index 293f0817c4e..3c300d643eb 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 cde79427fd7..38dea2a8090 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/woke02.html b/team/woke02.html index 2f89cbc8fcc..4e1defb780a 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 1910f2080ba..e36a613f1f8 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/xueting.html b/team/xueting.html index 52a5dd3dbf1..7534494426c 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 47c5e10c847..c929e84b720 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/zwezeya.html b/team/zwezeya.html index 8078b3f498e..e57e1c9d872 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 c9187ec3619..93e46895b0c 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, 3:04:42 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, 8:14:18 GMT+8]")])])])} }]; \ No newline at end of file