[CS2113-T15-3] SplitLiang

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+data/

build.gradle

@@ -3,6 +3,7 @@ plugins {
     id 'application'
     id 'checkstyle'
     id 'com.github.johnrengelman.shadow' version '7.1.2'
+    // id 'org.openjfx.javafxplugin' version '0.1.0'
 }
 
 repositories {
@@ -43,4 +44,10 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
+
+//javafx {
+//    version = "21"
+//    modules = [ 'javafx.controls' ]
+//}

docs/AboutUs.md

@@ -1,9 +1,11 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+
+Display |     Name      | Github Profile | Portfolio 
+--------|:-------------:|:--------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) |    Hafiz      | [Github](https://github.com/hafizuddin-a) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Heng Junxiang | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Akshan     | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   John Roe    | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Don Roe    | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+

docs/DeveloperGuide.md

@@ -2,28 +2,131 @@
 
 ## Acknowledgements
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the
+original source as well}
 
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### Help menu feature
+
+#### Implementation
+
+The "help" feature is facilitated by the  `Help` class.
+It provides a static method `printHelp` to print out a guide on how to use the commands in the application.
+`printHelp` can be used in the event the user issues an invalid command
+
+### Group Creation feature
+
+#### Implementation
+
+The "Group Creation" feature is facilitated by the `Group` class. It provides methods to create a new group and manage
+group membership. The implementation of this feature is as follows:
+
+The Group class maintains a list of members as a `private List<User>` field called `members`.
+
+The `createGroup(String groupName)` method is responsible for creating a new group. It performs the following steps:
+
+1. Checks if a group with the given `groupName` already exists using the `isGroup(String groupName)` method.
+2. If the group does not exist, creates a new `Group` object with the provided `groupName`.
+3. Prints a success message indicating that the group has been created.
+4. Adds the new `Group` object to the `groups` list.
+5. Returns the newly created `Group` object.
+6. If the group already exists, prints an error message indicating that the group already exists.
+
+### Add Member to Group feature
+
+#### Implementation
+
+The "Add Member to Group" feature is facilitated by the `Group` class. It provides methods to manage group membership
+and allows users to add new members to an existing group. The implementation of this feature is as follows:
+
+The Group class maintains a list of members as a `private List<User>` field called `members`.
+
+Users can add a new member to the group by using the command `member USER_NAME`. The `addMember(String memberName)` method is responsible for adding a new member to the group. It performs the following steps:
+
+1. Checks if a user with the given `memberName` is already a member of the group using the `isMember(String memberName)`
+   method.
+2. If the user is not a member, creates a new `User` object with the provided `memberName`.
+3. Adds the new `User` object to the `members` list.
+4. Prints a success message indicating that the member has been added to the group.
+
+![Sequence Diagram](AddMember.png)
+
+### Expenses feature
+
+#### Implementation
+
+The Expenses feature is facilitated through the Expense class. It allows users to add a new Expense through creation of
+a new Expense object. Users can specify amount paid, the payee, and the members of the group involved in the
+transaction.
+Additionally, it implements the following operations:
+
++ `Expenses#payer()` - Gives the name of the member who paid for the expense
++ `Expenses#totalAmount()` - Returns the total amount of the expense
++ `Expenses#payees()` - Returns all the members involved in the transaction
+
+These operations are exposed in the Expense class through the `getPayerName()`, `getTotalAmount()`, and `getPayees()`
+functions respectively.
+
+### Balance feature
+
+#### Implementation
+
+The Balance feature is facilitated through the Balance class.
+It allows a user to view a printed list of other users in the Group, and the amount that is owed by/to each user.
+
+Each `Balance` object contains a String of a user `userName`,
+and a Map `balanceList`. This Map uses String of other users' usernames as Key, and
+a Float of the amount that is owed by/to each user.
+
+To print a user's Balance List, perform the following steps:
+
+1. Create a `Balance` object with the params String `userName` and the current Group `group`.
+2. From the `members` and `expenseList` List items in `group`, the Map `balanceList` is populated.
+3. Call method `printBalance()` to print the contents of the Map `balanceList`.
+
+### Settle feature
+
+#### Implementation
+
+The Settle feature is facilitated through the Settle class.
+It allows a user to settle the debts between two users in a Group.
+
+ The `Settle` class contains a `settleDebt(String userName1, String userName2)` method.
+This method takes in two Strings `userName1` and `userName2` as parameters, representing the two users to settle the
+debt between.
+
+The method then prints out the amount that is owed by `userName1` to `userName2`, and the amount that is owed
+by `userName2` to `userName1`.  It then prints out the total amount that is owed between the two users, and prompts the user to enter the amount to
+settle the debt.
+
+The method then prints out the amount that is owed by `userName1` to `userName2`, and the amount that is owed
+by `userName2` to `userName1` after the settlement.
 
 ## Product scope
+
 ### Target user profile
 
 {Describe the target user profile}
+Our target users are people who share expenses with friends, family, roommates, or colleagues.
+The application gives an accurate and simple way to represent unsettled debts between users and their friends
 
 ### Value proposition
 
 {Describe the value proposition: what problem does it solve?}
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+| Version | As a ... | I want to ...                                                  | So that I can ...                                           |
+|---------|----------|----------------------------------------------------------------|-------------------------------------------------------------|
+| v1.0    | new user | see usage instructions                                         | refer to them when I forget how to use the application      |
+| v1.0    | user     | add a new expense with description, amount, and users involved | split the expense equally                                   |
+| v1.0    | user     | create a new group                                             | split expenses with different groups                        |
+| v1.0    | user     | list all expenses within a group                               | see recent transactions                                     |
+| v1.0    | user     | check how much I owe each member in the group                  | keep track of my debts                                      |
+| v2.0    | user     | find a to-do item by name                                      | locate a to-do without having to go through the entire list |
 
 ## Non-Functional Requirements
 

docs/README.md

@@ -1,4 +1,4 @@
-# Duke
+# Split-liang (An app to help you split expenses with friends in a fun way!)
 
 {Give product intro here}
 

docs/UserGuide.md

@@ -2,7 +2,8 @@
 
 ## Introduction
 
-{Give a product intro}
+Split-liang is an application that helps you split expenses with friends in a fun way!
+
 
 ## Quick Start
 
@@ -15,28 +16,146 @@
 
 {Give detailed description of each feature}
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+### Viewing help: `help`
+Shows a message explaining how to use the application.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Format: `help`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+### Creating a group: `create group`
 
-Example of usage: 
+Creates a new group with the specified group name.
 
-`todo n/Write the rest of the User Guide d/next week`
+Format: `create group GROUP_NAME`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+- `GROUP_NAME` is the name of the group.
 
-## FAQ
+Example: `create Friends`
+
+This command will create a new group named 'Friends'.
+
+### Entering a group: `enter`
+
+Enters an existing group with the specified group name.
+
+Format: `enter GROUP_NAME`
+
+- `GROUP_NAME` is the name of the group.
+
+Example: `enter Friends`
+
+This command will enter the group named 'Friends'.
+
+### Add members to group: `member`
+
+Adds a new member to the group.
+
+Format: `member USER_NAME`
+- `USER_NAME` is the name of the user to be added to the group. 
+
+Example: `member Alice`
+
+This command will add a new member named 'Alice' to the group.
+
+Output: `Alice has been added to group.`
+
+
+### Exiting a group: `exit`
+
+Exits the current group.
+
+Format: `exit GROUP_NAME`
+
+Example: `exit Friends`
+
+This command will exit the current group.
+
+### Show balance of user: `balance`
+
+Shows list of members the user owes money to.
+
+Format: `balance USER_NAME`
+
+Example: `balance Shaoliang`
+
+This command will display the balance of the user named Shaoliang.
 
-**Q**: How do I transfer my data to another computer? 
+### Settle expenses: `settle`
+
+Settles the expenses between two users in the group.
+
+Format: `settle USER_NAME1 /user USER_NAME2`
+
+- `USER_NAME1` is the name of the first user.
+- `USER_NAME2` is the name of the second user.
+- `/user` is a keyword to indicate the start of the second user's name.
+
+Example: `settle Alice /user Bob`
+
+This command will settle the expenses between Alice and Bob, showing what Alice owes Bob.
+
+### Trying your luck: `luck`
+
+Play slots to remove debts
+
+Format: `luck` (Coming soon feature)
+
+- Enters the slot machine 
+  - `/reroll` to reroll the slots
+  - `/exit` to exit the slot machine
+  - Example: `/reroll`
+
+This command enable users play slots to remove their debts
+
+### Create expenses: `expense`
+
+Create a new expense for a given group.
+
+#### Create expense split equally
+Format:`expense DESCRIPITON /amount AMOUNT /paid PAYER_USER_NAME /user USER_NAME /user USER_NAME`
+
+`PAYER_USER_NAME` is the username of the person who paid for the transaction.
+`USER_NAME` is the username of the payee.
+
+- The amount will be split equally between all members including the payer.
+- The expense will be added to a list of expenses.
+
+#### Create expense split unequally
+Format:`expense DESCRIPITON /unequal /amount TOTAL_AMOUNT 
+/paid PAYER_USER_NAME /user USER_NAME AMOUNT_OWED /user USER_NAME AMOUNT_OWED`
+
+`PAYER_USER_NAME` is the username of the person who paid for the transaction.
+`USER_NAME` is the username of the payee.
+`AMOUNT_OWED` is the amount owed by the 
+
+- The amount will be split unequally between all members including the payer based on the `AMOUNT_OWED`.
+- The expense will be added to a list of expenses.
+
+### Saving the data
+
+Split-liang automatically saves the data in each group to `GROUP_NAME.txt` in the `data` folder after the application exits. There is no need to save manually.
+
+The data is loaded automatically when the application starts.
+
+### Saying goodbye: `bye`
+
+This command exits the application.
+
+
+## FAQ
 
-**A**: {your answer here}
+1. **Q: How do I create a new group?**
+   - A: To create a new group, use the `create group` command followed by the group name.
+2. **Q: How do I transfer my data to another device?**
+   - A: You can copy the `data` folder to the new device to transfer your data. 
 
 ## Command Summary
 
 {Give a 'cheat sheet' of commands here}
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+- `help`: Shows a message explaining how to use the application.
+- `create group GROUP_NAME`: Creates a new group with the specified group name.
+- `enter GROUP_NAME`: Enters an existing group with the specified group name.
+- `member USER_NAME`: Adds a new member to the group.
+- `exit`: Exits the current group.
+- `settle USER_NAME1 /user USER_NAME2`: Settles the expenses between two users in the group.
+- `bye`: Exits the application.