[CS2103T-T16-2] FriendFolio

.github/workflows/gradle.yml

@@ -26,6 +26,14 @@ jobs:
         working-directory:  ${{ github.workspace }}/.github
         run: ./run-checks.sh
 
+      - name: Set up Xvfb
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y xvfb
+          Xvfb :99 -screen 0 1280x1024x24 &
+          echo "DISPLAY=:99" >> $GITHUB_ENV
+
       - name: Validate Gradle Wrapper
         uses: gradle/wrapper-validation-action@v1
 

.gitignore

@@ -2,6 +2,7 @@
 /.gradle/
 /build/
 src/main/resources/docs/
+/bin/
 
 # IDEA files
 /.idea/

README.md

@@ -1,14 +1,18 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
-
+[![Java CI](https://github.com/AY2324S2-CS2103T-T16-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S2-CS2103T-T16-2/tp/actions/workflows/gradle.yml)
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+# FriendFolio
+
+## Description
+
+* The project simulates an ongoing software project for a desktop application (called _FriendFolio_) used for managing
+  contact details.
+    * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC)
+      than what students usually write in beginner-level SE modules, without being overwhelmingly big.
+    * It comes with a **reasonable level of user and developer documentation**.
+
+## Useful Links
+
+* FriendFolio's [Main Website Link](https://ay2324s2-cs2103t-t16-2.github.io/tp/)
+* FriendFolio's [User Guide Link](https://ay2324s2-cs2103t-t16-2.github.io/tp/UserGuide.html)
+* FriendFolio's [Developer Guide Link](https://ay2324s2-cs2103t-t16-2.github.io/tp/DeveloperGuide.html)

build.gradle

@@ -59,14 +59,21 @@ dependencies {
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
+    implementation group: 'com.google.zxing', name: 'core', version: '3.3.2'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+    testImplementation 'org.testfx:testfx-core:4.0.16-alpha'
+    testImplementation 'org.testfx:testfx-junit5:4.0.16-alpha'
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'friendfolio.jar'
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}

docs/AboutUs.md

@@ -9,51 +9,38 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Lim Zhekai
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zhekaiii.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/zhekaiii)]
 
-* Role: Project Advisor
-
-### Jane Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Birthday, Pay Command, Sort Command
 
-### Johnny Doe
+### Alvin Ng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/alvinnzz.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/alvinnzz)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Money Owed, Split Command, Lend Command
 
-### Jean Doe
+### Oon Jie Rui
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jerryo3.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jerryo3)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Filter Command, Days Available
 
-### James Doe
+### Newton Koh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/newtonkoh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/newtonkoh)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: UI, Remark Command

docs/DevOps.md

@@ -4,22 +4,22 @@ title: DevOps guide
 ---
 
 * Table of Contents
-{:toc}
+  {:toc}
 
 --------------------------------------------------------------------------------------------------------------------
 
 ## 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](https://se-education.org/guides/tutorials/gradle.html)**.
-
+This project uses Gradle for **build automation and dependency management**. **You are recommended to
+read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html)**.
 
 Given below are how to use Gradle for some important project tasks.
 
-
 * **`clean`**: Deletes the files created during the previous build tasks (e.g. files in the `build` folder).<br>
   e.g. `./gradlew clean`
 
-* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is outdated*.<br>
+* **`shadowJar`**: Uses the ShadowJar plugin to creat a fat JAR file in the `build/lib` folder, *if the current file is
+  outdated*.<br>
   e.g. `./gradlew shadowJar`.
 
 * **`run`**: Builds and runs the application.<br>
@@ -29,41 +29,54 @@ Given below are how to use Gradle for some important project tasks.
   **`checkstyleTest`**: Runs the code style check for the test code base.
 
 * **`test`**: Runs all tests.
-  * `./gradlew test` — Runs all tests
-  * `./gradlew clean test` — Cleans the project and runs tests
+    * `./gradlew test`— Runs all tests
+    * `./gradlew clean test`— Cleans the project and runs 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.
+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.
+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.
+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](https://se-education.org/guides/tutorials/codecov.html).
+To enable Codecov for forks of this project, follow the steps given
+in [this se-edu guide](https://se-education.org/guides/tutorials/codecov.html).
 
 ### 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.
+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:
+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:**
 
-* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` 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.
+* Checks are implemented as executable `check-*` scripts within the `.github` directory. The `run-checks.sh` 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.
 
 * Check scripts should print out errors in the format `SEVERITY:FILENAME:LINE: MESSAGE`
-  * SEVERITY is either ERROR or WARN.
-  * FILENAME is the path to the file relative to the current directory.
-  * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
+    * SEVERITY is either ERROR or WARN.
+    * FILENAME is the path to the file relative to the current directory.
+    * LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.
 
 * Check scripts must exit with a non-zero exit code if any errors occur.
 
@@ -73,7 +86,9 @@ Any warnings or errors will be printed out to the console.
 
 Here are the steps to create a new release.
 
-1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
+1. Update the version number
+   in [`MainApp.java`](https://github.com/AY2324S2-CS2103T-T16-2/tp/tree/master/src/main/java/seedu/address/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
 1. Tag the repo with the version number. e.g. `v0.1`
-1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.
+1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you
+   created.