[CS2113-F13-2] BrokeMan

.gitignore

@@ -2,12 +2,13 @@
 /.idea/
 /out/
 /*.iml
-
 # Gradle build files
 /.gradle/
 /build/
 src/main/resources/docs/
-
+# Any other files that should not be committed
+/data/
+*.jar
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.brokeMan.BrokeMan
+

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+Budget Manager
 
 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.
 

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "seedu.brokeMan.BrokeMan"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "brokeMan"
     archiveClassifier = null
 }
 

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) |      Yu Sichen     | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo) |      Liam Van      | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo) | Samuel Tan Sze Wee | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo) |     Sangjun Nam    | [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

@@ -1,38 +1,251 @@
 # Developer Guide
 
+## Table of Contents
+
+1. [Acknowledgements](#acknowledgements)
+2. [Design](#design)
+   - [Architecture](#architecture)
+   - [UI component](#ui-component)
+   - [Parser component](#parser-component)
+   - [Storage component](#storage-component)
+   - [Common classes](#common-classes)
+3. [Implementation](#implementation)
+4. [Appendix: Requirements](#appendix--requirements)
+5. [Appendix: Instructions for manual testing](#appendix--instructions-for-manual-testing)
+
+---
+
 ## 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}
+
+- [addressbook-level2](https://github.com/se-edu/addressbook-level2)
+- [addressbook-level3](https://github.com/se-edu/addressbook-level3)
+
+---
+
+## Design
+
+### Architecture
+
+![Architecture Diagram](images/ArchitectureDiagram.png)
+
+The ***architecture diagram*** given above is explains the high level design of the program.
+
+Given below is a quick overview of the main components and how they interact with each other.
+
+**Main components of architecture**
+
+`BrokeMan` has one class [`Main`](https://github.com/AY2223S2-CS2113-F13-2/tp/blob/master/src/main/java/seedu/brokeMan/BrokeMan.java), which is responsible for:
+- At program launch: Initialises the components in the correct sequence, and connect them up with each other
+- At program termination: Shuts down the components and invokes cleanup methods where necessary.
+
+[`Common`](#common-class) represents a collection of messages used by multiple other components.
+
+The rest of the program consists of mainly 5 main components.
+- [`Ui`](#ui-component): The Ui of the program.
+- [`Parser`](#parser-component): The user input parser.
+- [`Command`](#command-component): The command executor.
+- [`Storage`](#storage-component): Reads data from, and writes data to hard disk.
+- [`EntryList`](#entrylist-component): Stores the list of entries when program is running.
+
+### Ui component
+
+### Parser component
+
+### Command component
+
+### Storage component
+
+### EntryList component
+
+### Common class
+
+Messages used by multiple components are in the `seedu.brokeMan.commmon` package.
+
+---
+
+## implementation
+
+### Entry
+
+Entry class is the underlying superclass for Expense and Income classes. It establishes the common attributes and
+methods that are necessary to represent Expenses and Incomes. Abstract class is used to represent their common features
+to maximize code reusability and increase maintainability.
+
+Private attributes
+
+Info: String that stores the description of the entry
+
+Amount: Double that stores the monetary value of entry
+
+Time: LocalDateTime that stores the date and time of entry
+
+Category: Category that stores the type tag of entry
+
+**Methods**
+
+Getters can be used to provide the private attributes to other classes
+
+editDescription(), editAmount(), editTime(), editCategory()
+
+* Takes in corresponding parameters to edit the private attributes.
+* Used by EntryList to make edits
+
+isSameMonth()
 
-## Design & implementation
+* Takes in Integer year and Month month and returns if the entry is made in the date specified by parameters.
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### EntryList
 
+The EntryList class represents a collection of Entry instances. It is an abstract class that serves as a superclass for
+ExpenseList and IncomeList classes, providing common functionalities to minimize repetitive code and easing code
+maintenance. It provides underlying methods for adding, removing, editing, and listing entries from the list, which can
+be expenses or incomes depending on the subclass.
 
-## Product scope
-### Target user profile
+On top of the methods that provide basic functionality of expense/income lists, the EntryList class provides additional
+methods such as summing all entries or filtering the entries according to LocalDate provided to the method. Most methods
+of EntryList take in a List<Entry>, which is because it has to operate on a list of expenses or incomes passed by the
+IncomeList or ExpenseList subclasses.
 
-{Describe the target user profile}
+**Methods**
 
-### Value proposition
+addEntry()
 
-{Describe the value proposition: what problem does it solve?}
+* Takes an Entry instance as a parameter and adds it to the class-level list
 
-## User Stories
+listEntry()
 
-|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|
+* Takes in a list of Entry and passes them to the UI to print to the user.
+* Makes use of toString() method of entries.
 
-## Non-Functional Requirements
+deleteEntry()
+
+* Takes in the list of entry and index of the entry to be deleted.
+* The method acts as an underlying method for subclasses' deletion methods.
+
+editEntry()
+
+* Overloaded method. All methods take in the LinkedList of entries and the index of the entry that has to be edited.
+  Another parameter has to be provided, which can be double, LocalDateTime, or String.
+* additional parameter double edits the money amount of the entry in the list.
+* additional parameter LocalDateTime edits the time when the entry is made.
+* additional parameter String edits the description of the entry in the list.
+
+getTotalAmount()
+
+* Takes in a list of entries and returns the sum of all entry's monetary value.
+
+SortEntryByAmount()
+
+* Returns a sorted list of entry by amount of entry.
+
+SortEntryByDate()
+
+* Returns a sorted list of entry by date of entry.
+
+findEntriesByCategory()
+* Returns a list of entries with the same category and the total amount in this category.
+
+### ExpenseList, IncomeList
+
+Classes ExpenseList and IncomeList is responsible for keeping track of the corresponding entry instances added to the program by the user. 
+At a class level, it keeps a **LinkedList** of corresponding entries. 
+They both extend EntryList, the abstract class that represents a collection of Entry instances. 
+It provides static functionalities of managing and viewing entry instances at a class level. 
+Instances of ExpenseList and IncomeList are not created as all functionalities can be provided at the class level. 
+
+**Methods**
+
+listExpense() / listIncome()
+
+* Overloaded method, may take it no parameter or LocalDate parameter
+* If it has no passed parameters, it returns all entries in the list
+* If a LocalDate is passed, it returns all entries made in the month specified by LocalDate instance.
+
+### Budget
+
+The Budget class represents the user’s monthly budget. The class utilize class-level hashmaps to represent the monthly
+budget, using outer key year and inner key month. It provides a method to set and view budget for different months.
+
+It makes use of a static HashMap<Integer, HashMap<Month, Double>> to keep track of monthly budget. If the user tries to
+access budget using keys that are not entered in the HashMap, it will return a warning mentioning that the inquired
+budget has not been set yet.
+
+### SaveExpense, SaveIncome
+
+The SaveExpense and SaveIncome class deal with saving in the user inputted data locally so that it can be later accessed.
+**Methods**
+
+writeFile(LinkedList<Entry> expenses/incomes)
+* writes to the file in a similar format that is entered in to make a new Expense object within the constructor.
+*
+readExpenseFile()
+
+* This method reads in from the saved file either ExpenseData.txt or IncomeData.txt. Reads in and initialized each line as either expense or income. Then adds to the respective list.
+
+---
+
+|Version| As a ... | I want to ...                                                         | So that I can ...                                |
+|--------|----------|-----------------------------------------------------------------------|--------------------------------------------------|
+|v1.0|user| add, delete, edit, and list my income                                 | manage my income                                 |
+|v1.0|user| add, delete, edit, and list my expenses                               | manage my expenses                               |
+|v1.0|user| set and view my budget                                                | set expectation of how much money I should use   |
+|v1.0|user| view how much of the budget I spend                                   | manage and change my spending habit as necessary |
+|v1.0|user| view all comments that I can enter                                    | get help on the features if necessary            |
+|v2.0|user| list monthly expenses, income, and budget                             | refer to financial status in previous months     |
+|v2.0|user| set the category of income and expenses, and list entries by category | refer to expenses and income by category         |
+
+## Appendix: Requirements
+
+### Product scope
+
+**Target user profile**:
+
+- BrokeMan is suitable for students who have to work with tight budgets
+- students who want to use their money efficiently
+- students who want to minimize their spending.
+- students who can type fast
+- prefer typing to mouse interactions
+- is reasonably comfortable using CLI apps
+
+**Value proposition**:
+
+- Manage income and expenses faster than a typical mouse/GUI driven app
+- The program will offer visualization of the user's incomes, expenses and budget, allowing them to recap and be mindful
+  about their financial status. The project will allow division of budget into multiple subcategories of expenses. In
+  essence, the program sets students up for a better financial future.
+
+### User Stories
+
+Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
+
+| Priority | Version | As a ... | I want to ...                             | So that I can ...                                |
+|----------|---------|----------|-------------------------------------------|--------------------------------------------------|
+| `* * *`  | v1.0    | user     | add, delete, edit, and list my income     | manage my income                                 |
+| `* * *`  | v1.0    | user     | add, delete, edit, and list my expenses   | manage my expenses                               |
+| `* * *`  | v1.0    | user     | set and view my budget                    | set expectation of how much money I should use   |
+| `* * *`  | v1.0    | user     | view how much of the budget I spend       | manage and change my spending habit as necessary |
+| `* * *`  | v1.0    | user     | view all command that I can enter         | get help on the features if necessary            |
+| `* * *`  | v2.0    | user     | list monthly expenses, income, and budget | refer to financial status in previous months     |
+| `* * *`  | v2.0    | user     | save all my income and expenses entered   | so that I can refer to it next time I return     |
+
+*{more to be added}*
+
+### Use cases
+
+### Non-Functional Requirements
 
 {Give non-functional requirements}
 
 ## Glossary
 
-* *glossary item* - Definition
+- **Mainstream OS**: Windows, Linux, Unix, OS-X
+- Command Line Interface (CLI)
+
+---
 
-## Instructions for manual testing
+## Appendix: Instructions for manual testing
 
 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}