[CS2103-T16-3] UniCa$h

.github/workflows/gradle.yml

@@ -39,7 +39,7 @@ jobs:
         run: ./gradlew check coverage
 
       - name: Upload coverage reports to Codecov
-        if: runner.os == 'Linux'
+        if: runner.os == 'Windows'
         uses: codecov/codecov-action@v3
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/unit_test.yml

@@ -0,0 +1,41 @@
+name: Java Unit Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@master
+
+      - name: Set up repository
+        uses: actions/checkout@master
+        with:
+          ref: master
+
+      - name: Merge to master
+        run: git checkout --progress --force ${{ github.sha }}
+
+      - name: Validate Gradle Wrapper
+        uses: gradle/wrapper-validation-action@v1
+
+      - name: Setup JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: '11'
+          java-package: jdk+fx
+
+      - name: Build and check with Gradle
+        run: ./gradlew check
+
+      - name: Run unit tests
+        run: ./gradlew test
+
+      - name: Run UI unit tests (on Windows only)
+        if: runner.os == 'Windows'
+        run: ./gradlew uiTest

README.md

@@ -1,14 +1,23 @@
+# UniCa$h
+
 [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103-T16-3/tp/graph/badge.svg?token=LPKS424C1Y)](https://codecov.io/gh/AY2324S1-CS2103-T16-3/tp)
+
+> UniCa$h is a finance tracking application for university students who want to be more financially conscious.
 
+## About
 ![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.
+User Target Profile: Our application is for university students who want to be more financially conscious about their
+spending habits, to enable them to make more economical decisions that provide students on a limited budget with more
+purchasing power.
+
+Value Proposition: It provides university students with an intuitive and frictionless experience to have transparency on
+their expenditure to help them better understand their spendings so they can develop better financial habits as they
+transition into adulthood.
+
+You can find our User Guide [here](https://ay2324s1-cs2103-t16-3.github.io/tp/UserGuide.html), and our Developer Guide [here](https://ay2324s1-cs2103-t16-3.github.io/tp/DeveloperGuide.html)!
+
+## Credits
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'unicash.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -21,14 +21,37 @@ checkstyle {
 }
 
 test {
+    doFirst {
+        exclude "**/**UiTest*"
+    }
+    useJUnitPlatform()
+    finalizedBy jacocoTestReport
+}
+
+// Specialized task to run only UI related unit tests
+tasks.register('uiTest', Test) {
+    doFirst {
+        include "**/**UiTest*"
+    }
     useJUnitPlatform()
     finalizedBy jacocoTestReport
 }
 
+jacocoTestReport {
+    dependsOn test
+    // Only run the UI tests when on Windows
+    def disallowedOSes = ['mac', 'ubuntu', 'nux']
+    def os = System.getProperty("os.name").toLowerCase()
+    def isAllowed = disallowedOSes.every { !os.contains(it) }
+    if (isAllowed) {
+        dependsOn uiTest
+    }
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
-    executionData.from files(jacocoTestReport.executionData)
+    executionData fileTree(project.rootDir.absolutePath).include("**/build/jacoco/*.exec")
     afterEvaluate {
         classDirectories.from files(classDirectories.files.collect {
             fileTree(dir: it, exclude: ['**/*.jar'])
@@ -63,10 +86,19 @@ dependencies {
     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.17"
+    testImplementation "org.testfx:testfx-junit5:4.0.17"
+    testImplementation group: 'org.hamcrest', name: 'hamcrest', version: '2.1'
+    testImplementation "org.testfx:openjfx-monocle:jdk-11+26"
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'unicash.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -9,51 +9,52 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Woo Jia Hao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/woojiahao.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](https://woojiahao.com/)]
+[[github](https://github.com/woojiahao)]
+[[portfolio](team/woojiahao.md)]
 
-* Role: Project Advisor
+* Role: Developer 
+* Responsibilities: Documentation, Testing, PR reviews, Continuous Integration
 
-### Jane Doe
+### Jamie Toh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jamz903.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jamz903)]
+[[portfolio](team/jamz903.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: UI, Documentation, Testing
 
-### Johnny Doe
+### Tan Lip Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lipwei1808.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/lipwei1808)] [[portfolio](team/lipwei1808.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Model
 
-### Jean Doe
+### Ernest Liu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/elhy1999.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/elhy1999)]
+[[portfolio](team/elhy1999.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Documentation, Testing
 
-### James Doe
+### Rubesh Suresh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sp4ce-cowboy.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/sp4ce-cowboy)]
+[[portfolio](team/sp4ce-cowboy.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: User Interface, Documentation and Testing