[CS2113T-T10-4] MindMyMoney

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+list.txt
+/src/main/java/META-INF

README.md

@@ -1,6 +1,6 @@
 # Duke project template
 
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
+This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it
 
 ## Setting up in Intellij
 

build.gradle

@@ -29,7 +29,7 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.mindmymoney.MindMyMoney"
 }
 
 shadowJar {
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # 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) | Dan Baterisna   |  [Github](https://github.com/danbaterisna)  | [Portfolio](docs/team/johndoe.md) |
+| [](https://via.placeholder.com/100.png?text=Photo) | Glendon Ng      | [Github](https://github.com/GlendonNotGlen) | [Portfolio](docs/team/johndoe.md) |
+| [](https://via.placeholder.com/100.png?text=Photo) | Lim Jie Rui     |   [Github](https://github.com/limjierui)    | [Portfolio](docs/team/johndoe.md) |
+| [](https://via.placeholder.com/100.png?text=Photo) | Seah Kit Han    |     [Github](https://github.com/khseah)     | [Portfolio](docs/team/johndoe.md) |
+| [](https://via.placeholder.com/100.png?text=Photo) | Sean Ho Wen Bin |    [Github](https://github.com/SeanHoWB)    | [Portfolio](docs/team/johndoe.md) |

docs/DeveloperGuide.md

@@ -4,10 +4,150 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+## Design
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Architecture
+![architecture diagram](images/architecture_diagram.png)
+<br/> Fig 1 - Architecture Diagram
 
+The Architecture Diagram above shows the high-level design of the application. The **main components**
+consist of:
+- `MMM`: Initialises the components in the correct sequence and connects them with each other. Also holds the user's
+expenditures in memory.
+- `Ui`: The User Interface of the application and deals with interaction with the user.
+- `Parser`: Deals with making sense of user commands.
+- `Commands`: The collection of all executable commands.
+- `Storage`: Reads data from, and writes data to the hard disk.
+
+By abstracting out closely related code into classes, it allows`MMM`to deal at a higher level, without worrying
+about the lower level details. Higher cohesion is also achieved and coupling is minimized as each component is
+only coupled to the main class,`MMM`.
+
+The Sequence Diagram below shows an example of how the components interact with each other for the scenario 
+where the user issues the command`add shoes 100`.
+
+![sequence_diagram](images/sequence_diagram.png)
+<br/> Fig 2 - Sequence Diagram
+
+The sections below give more details for each component.
+
+<br/>
+
+### UI component
+The source code can be found in [Ui.java](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Ui.java)
+
+![ui_diagram](images/ui_diagram.png)
+<br/> Fig 3 - Ui Diagram
+
+The UI component consists of a`Ui`and`PrintStrings`class.
+
+The UI component:
+- Prints the welcome banner and message on startup, as well as a financial tip from the`PrintStrings`class.
+- Prints`>`before the user's input, to help the user differentiate between their input and an output from the
+application.
+- Reads input from the user.
+
+<br/>
+
+### Parser component
+The source code can be found in [Parser.java](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Parser.java)
+
+![parser_diagram](images/parser_diagram.png)
+<br/> Fig 4 - Parser Diagram
+
+The Parser component consists of a`Parser`, `Functions`, `ExpenditureList` and `Expenditure`class
+
+The Parser component:
+- Receives user's input and splits it into the Command Type and Description using the`Functions`class.
+- Uses the`itemList`, which is an`ExpenditureList`object, to instantiate a`Command`object based on the Command Type.
+- Returns the`Command`object that can then be executed.
+
+We pass in the`itemList`to the`Command`object instead of using a global variable to ease testing. This way, we can 
+add, delete and update`Expenditure`entries in a new`itemList`during testing without affecting the actual`itemList`.
+
+### Command component 
+The source can be found in [command](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/command)
+
+![command_diagram](images/command_diagram.png)
+<br/> Fig 5 - Command Diagram
+
+The Command component consists of `Command` abstract class, `AddCommand`, `ByeCommand`, `DeleteCommand`, `HelpCommand`
+, `ListCommand`and `UpdateCommand` that extends the `Command` class.
+
+The Command component:
+- Provides all the Command classes which can be instantiated by `Parser.parseCommand()`. The Command objects can then be 
+executed. Only 1 Command object can be created.
+- Includes a `.executeCommand()` method in each Command classes which performs the relevant command and throws 
+exceptions if an error is encountered. The error is then handled.
+
+### Storage component 
+The source can be found in [Storage.java](https://github.com/AY2122S2-CS2113T-T10-4/tp/blob/master/src/main/java/seedu/mindmymoney/Storage.java)
+
+![storage_diagram](images/storage_diagram.png)
+<br/> Fig 6 - Storage Diagram
+
+The Storage component consists of `Storage` class.
+
+The Storage component:
+- `MMM` class initialises a `Storage` object upon start up. The `Storage` class consists of 
+`load()` and `save()` methods. 
+- Concurrently, `MMM` will call the `load()` method and load any data that is stored on the hard disk.
+- `MMM` calls the `save()` method and stores remaining data onto the hard disk when the program exits.
+
+
+## Implementation
+This section describes some noteworthy details on how certain features are implemented.
+
+### Add Command Feature
+#### Current Implementation
+The sequence diagram below shows the interactions of different subcomponents of the system when adding an expenditure
+to the list.  
+![add_command_sequence_diagram](images/Add_Command_Sequence_Diagram.png)  
+A key functionality of MindMyMoney is the ability to add and track user expenditure. A user can add in a new expenditure
+by specifying the payment type, the category, the description of the item, the cost of the item and the date and the
+month purchased.
+
+1. The `Parser` component parses user input and returns the new `AddCommand` object to the
+   `MindMyMoney`.
+2. `AddCommand` instantiates `addInput`, `expenditureList` and `creditCardList`.
+3. The application invokes `Addcommand.execute` to execute user instruction.
+4. During the execution, `Addcommand.execute` will parse through user input to obtain the `EXPENDITURE`, `CATEGORY`,
+   `DESCRIPTION`, `AMOUNT` and `TIME` fields.
+5. The `Addcommand` object instantiates a new `Expenditure` object with the aforementioned 5 fields and adds them
+   into the `ExpenditureList`.
+6. The `Addcommand` object prints a list to show the user what it has saved.
+
+#### Design considerations
+Aspect: How to ask user for the 5 fields of input
+* Alternative 1 (current choice): User is asked to put in all 5 fields at once, separated using flags.
+    * Pros: Faster input, user can enter an expenditure using a single input.
+    * Cons: User must be able to remember all the flags and its sequence.
+
+* Alternative 2: User is asked iteratively to put in all 5 fields, prompted by a message after each input.
+    * Pros: Beginner friendly, easily understandable, no need to remember flags.
+    * Cons: Slower, implementation when user is familiar with the application.
+
+### Calculate Command feature
+
+To enable users to view their finances in a more meaningfully, MindMyMoney does calculations to present financial data
+that is actionable for the users.
+
+![calculate_command_sequence_diagram](images/gif_loading.gif)
+
+### List Command feature
+To enable users to view their current list of added expenditures. 
+
+#### Design considerations
+Aspect: How to make the list command easily tested using JUnit testing
+* Alternative 1 (current choice): Abstract the conversion of Expenditure to String in a separate listToString() method
+  * Pros: Easily tested using JUnit testing, by checking the String that the listToString() method returns
+  * Cons: Added layer of abstraction that may be deemed redundant
+
+* Alternative 2: Print directly in the ListCommand.executeCommand() method 
+  * Pros: Easily implemented with lesser lines of code as the code is minimalist
+  * Cons: JUnit testing would require I/O redirection prior to checking the output matches expectations
+
+![list_command_sequence_diagram](images/List_Command_Sequence_Diagram.png)
 
 ## Product scope
 ### Target user profile

docs/README.md

@@ -1,6 +1,21 @@
-# Duke
+# MindMyMoney (M<sup>3</sup>)
 
-{Give product intro here}
+MindMyMoney (M3) was proposed for users with multiple payment methods who wish to track their expenditures. Conducting
+anecdotal interviews, we realized users face difficulty tracking their expenditures across different payment platforms 
+on vastly different items. MindMyMoney was then conceptualized on the basis of tracking user’s expenditures.<br>
+
+The technical goal for the MindMyMoney (M3) is to develop an app for managing your expenditures, optimized for use via
+a Command Line Interface (CLI). M3 aims to be a one-stop shop for you to consolidate your expenditure across multiple 
+platforms, set budget goals and track your spending.
+
+
+# Quick Start
+
+1. Ensure that you have Java 11 or above installed.
+2. Down the latest version of `MindMyMoney` from [here](https://github.com/AY2122S2-CS2113T-T10-4/tp/releases).
+
+If the setup is correct, you should see something the following in your terminal:
+![start screenshot](./images/start.PNG)<br>
 
 Useful links:
 * [User Guide](UserGuide.md)