[CS2103T-W13-1] LoanGuard-Pro

.gitignore

@@ -10,11 +10,13 @@ src/main/resources/docs/
 
 # Storage/log files
 /data/
+/bin/
 /config.json
 /preferences.json
 /*.log.*
 hs_err_pid[0-9]*.log
 
+
 # Test sandbox files
 src/test/data/sandbox/
 

README.md

@@ -1,14 +1,16 @@
-[![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/AY2324S2-CS2103T-W13-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W13-1/tp/actions)
+
+[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W13-1/tp/graph/badge.svg?token=MZAGQZIFNS)](https://codecov.io/gh/AY2324S2-CS2103T-W13-1/tp)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is **LoanGuard Pro, an application that helps business owners manage clients and their loan details**.<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.
+  * to keep track of the items you have loaned out
+  * to view your history of loans by client
+* The project builds on an existing Address Book used for managing contact details, **adding in a loan tracker functionality**.
+  * It is **written in OOP fashion**.
   * 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.
+* It is named `LoanGuard Pro` because it represents a more powerful version of an address book, that can also manage the loans of your contacts.
+* For the detailed documentation of this project, see the **[LoanGuard Pro Product Website](https://ay2324s2-cs2103t-w13-1.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -4,6 +4,7 @@ plugins {
     id 'com.github.johnrengelman.shadow' version '7.1.2'
     id 'application'
     id 'jacoco'
+    id 'org.jetbrains.kotlin.jvm' version '1.9.21'
 }
 
 mainClassName = 'seedu.address.Main'
@@ -63,10 +64,25 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
 }
 
 shadowJar {
     archiveFileName = 'addressbook.jar'
 }
 
+run {
+    enableAssertions = true
+}
+
 defaultTasks 'clean', 'test'
+compileKotlin {
+    kotlinOptions {
+        jvmTarget = "11"
+    }
+}
+compileTestKotlin {
+    kotlinOptions {
+        jvmTarget = "11"
+    }
+}

docs/AboutUs.md

@@ -9,51 +9,57 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Khor Jun Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kjw142857.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/kjw142857)]
+[[portfolio](https://github.com/kjw142857)]
 
-* Role: Project Advisor
+* Role: Developer for basic loan implementation + debugging and testing.
+* Responsibilities: Implementing the `linkloan` and `editloan` commands;
+finding bugs and pushing fixes; writing test code.
 
-### Jane Doe
+### Kyal Sin Min Thet
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/marcus-ny.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/marcus-ny)]
+[[portfolio](http://github.com/marcus-ny)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Team Lead + Frontend.
+* Responsibilities: setting up repo + CI workflow;
+Implementing view options for different panels - loans, contacts, analytics dashboards.
 
-### Johnny Doe
+### Teoh Tze Tzun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/joseph31416.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/Joseph31416)] [[portfolio](https://github.com/Joseph31416)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Developer for data classes and UG documentation.
+* Responsibilities:
+Implementing the `Loan`, `LoanRecords` (now refactored as `UniqueLoanList`) and `Analytics` classes from scratch;
+writing the user guide.
 
-### Jean Doe
+### Wang Junwu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/narwhalsilent.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/narwhalsilent)]
+[[portfolio](http://github.com/narwhalsilent)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer for loan architecture and UI integration + DG documentation.
+* Responsibilities: Implementing loan architecture as `UniqueLoanList` in the `Model`;
+implementing the `viewloan` command;
+writing the developer guide.
 
-### James Doe
+### Zhang Xiaorui
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/xiaorui-ui.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/xiaorui-ui)]
+[[portfolio](https://github.com/xiaorui-ui)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer for basic loan management and DG documentation.
+* Responsibilities: Implementing `deleteloan`, `markloan`, and `unmarkloan` commands; writing the developer guide.