[CS2103-F13-1] SpleetWaise

.codecov.yml

@@ -0,0 +1,5 @@
+ignore:
+  - "src/main/java/spleetwaise/commons/ui/*"
+  - "src/main/java/spleetwaise/address/ui/*"
+  - "src/main/java/spleetwaise/transaction/ui/*"
+  - "src/main/java/spleetwaise/commons/MainApp.java"

.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*       @seeyangzhi @seanlim @rollingpencil @gavinsin @Dino-Nuggies

.github/workflows/gradle.yml

@@ -1,12 +1,12 @@
 name: Java CI
 
-on: [push, pull_request]
+on: [ push, pull_request, workflow_dispatch ]
 
 jobs:
   build:
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
+        platform: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.platform }}
 
     steps:
@@ -23,7 +23,7 @@ jobs:
 
       - name: Run repository-wide tests
         if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/.github
+        working-directory: ${{ github.workspace }}/.github
         run: ./run-checks.sh
 
       - name: Validate Gradle Wrapper

README.md

@@ -1,14 +1,34 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2425S1-CS2103-F13-1/tp/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/AY2425S1-CS2103-F13-1/tp/actions?query=branch%3Amaster)
+
+[![codecov](https://codecov.io/gh/AY2425S1-CS2103-F13-1/tp/graph/badge.svg?token=91MOH0UZHU)](https://codecov.io/gh/AY2425S1-CS2103-F13-1/tp)
 
 ![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/#contributing-to-se-edu) for more info.
+---
+# [CS2103-F13-1] SpleetWaise
+
+> SpleetWaise builds on [AddressBook Level 3 (AB3)](https://se-education.org/addressbook-level3/), **a desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still offering the benefits of a Graphical User Interface (GUI). _Designed to streamline expense tracking for students_, SpleetWaise makes it easy to record and monitor both personal and shared expenses with contacts saved in the address book. With features to keep track of balances with friends, it eliminates the confusion often associated with managing shared costs, providing a clear, organised view of who has owes what. If you can type fast, SpleetWaise lets you handle your contact and expense management tasks more efficiently than traditional GUI apps, offering students a stress-free way to manage their expenses and shared balances with contacts.
+
+> **Target User**: Tech-savvy students looking to track shared expenses and manage who owes what.
+
+---
+
+* For the detailed documentation of this project, see
+  the [SpleetWaise Product Website](https://ay2425s1-cs2103-f13-1.github.io/tp/).
+
+---
+
+## Git Workflow
+
+This project uses the [Feature Branch Flow](https://nus-cs2103-ay2425s1.github.io/website/se-book-adapted/chapters/revisionControl.html#feature-branch-flow) with rules set to protect the `master` branch. PRs are mandatory and at least 1 member requires review.
+
+> Feature branches are branches being used to develop an individual story. They should be named "{issue-number}-{summary}" where "{issue-number}" is the issue number corresponding to the feature you are implementing and "{summary}" is a brief summary of the feature `formatted-like-this`.
+
+## Acknowledgement
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). 
+
+- Libraries
+  used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5), [Mockito](https://github.com/mockito/mockito), [TestFX](https://github.com/TestFX/TestFX)
+- References
+  used: [SE-EDU initiative](https://se-education.org/), [AB4](https://github.com/se-edu/addressbook-level4) 

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'spleetwaise.commons.Main'
 
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
@@ -20,20 +20,44 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+tasks.register('guiTests', Test) {
+    useJUnitPlatform()
+    include 'systemtests/**'
+    enableAssertions = true
+}
+
+tasks.register('nonGuiTests', Test) {
+    useJUnitPlatform()
+    include 'spleetwaise/address/**'
+    include 'spleetwaise/common/**'
+    include 'spleetwaise/transaction/**'
+    enableAssertions = true
+}
+
+tasks.register('allTests') {
+    dependsOn nonGuiTests, guiTests
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
+
+    systemProperty 'testfx.setup.timeout', '60000'
+    systemProperty 'java.awt.headless', 'true'
+    systemProperty 'prism.order', 'sw'
+    systemProperty 'prism.text', 't2k'
+    enableAssertions = true
+
+    exclude 'systemtests/**'
 }
 
-task coverage(type: JacocoReport) {
+tasks.register('coverage', JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
     executionData.from files(jacocoTestReport.executionData)
-    afterEvaluate {
-        classDirectories.from files(classDirectories.files.collect {
-            fileTree(dir: it, exclude: ['**/*.jar'])
-        })
-    }
+    classDirectories.setFrom(files(classDirectories.files.collect {
+        fileTree(dir: it, exclude: ['**/*.jar'])
+    }))
     reports {
         html.required = true
         xml.required = true
@@ -63,10 +87,24 @@ 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.18"
+    testImplementation "org.testfx:testfx-junit5:4.0.18"
+    testImplementation group: 'org.hamcrest', name: 'hamcrest', version: '2.1'
+    testImplementation group: 'org.assertj', name: 'assertj-core', version: '3.13.2'
+
+    testImplementation "org.mockito:mockito-core:5.14.2"
+    testImplementation 'org.mockito:mockito-junit-jupiter:5.14.2' // Add Mockito JUnit 5 integration
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveBaseName = "spleetwaise"
+    archiveVersion = "1.5.1"
+    archiveClassifier = null
+}
+
+run {
+    enableAssertions = true
 }
 
-defaultTasks 'clean', 'test'
+defaultTasks 'clean', 'nonGuiTests', 'coverage'