[CS2113-T15-3] Moneymind

.gitignore

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

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "seedu.moneymind.Moneymind"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "moneymind"
     archiveClassifier = null
 }
 
@@ -44,3 +44,7 @@ checkstyle {
 run{
     standardInput = System.in
 }
+
+run{
+    enableAssertions = true
+}

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # 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://avatars.githubusercontent.com/u/88603534?s=400&u=3007dc79299805aa3b8f71aeb61899ea9fb64f6e&v=4) |        Zhao Lixiuqi        | [Github](https://github.com/alexgoexercise) | [Portfolio](docs/team/Zhao_Lixiuqi.md)
+![](https://via.placeholder.com/100.png?text=Photo) |        Toh Hongfeng        |  [Github](https://github.com/Toh-HongFeng)  | [Portfolio](docs/team/tohhongfeng.md)
+![](https://via.placeholder.com/100.png?text=Photo) |        Li Mingyuan         |  [Github](https://github.com/mingyuannus)   | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |      Nguyen Duc Thang      |     [Github](https://github.com/Mnsd05)     | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -1,38 +1,269 @@
-# Developer Guide
+<div align="center">
+<h2> MoneyMind Developer Guide</h2>
+<h3> "Mind your Money" </h3>
+</div>
+
+<div align="left">
 
 ## Acknowledgements
 
 {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
+
+<img src="images\ArchitectureDiagram.png" width="300" />
+
+The ***Architecture Diagram*** given above explains the high-level design of the App. 
+
+Given below is a quick overview of how each component interact with each other.
+
+The main components in the architecture are:
+
+* `MoneyMind`: The main program of the application, 
+it initializes the other components in the correct sequence and is responsible for shut down the application.
+* `UI`: The user interface of the application.
+* `Storage`: The storage of data of the application.
+* `Data`: The data classes used in the application, including Event, Category and CategoryList.
+* `Command`: The command of the application, including AddCommand, DeleteCommand, ListCommand, etc.
+
+<img src="images\ArchitectureSequence.png" width="500" />
+
+The *sequence diagram* above shows how the components interact with each other for the scenario 
+where the user issues the command `event buy lunch e/10`.
+
+The following sections will explain the architecture in more detail.
+
+### Storage component
+
+**API**: `Storage.java`
+
+<img src="images\Storage.png" width="500">
+
+The `Storage` component,
+* can save category and event data in txt format, and read it back. (txt format is chosen because it is human readable)
+* depended on by `CategoryList.java` and `CategoryCommand.java` to load data to ArrayList and HashMap, and takes in an ArrayList of Category objects as parameter to save data.
+
+When the user first starts the application:<br>
+<img src="images\StorageSequenceDiagram.png" width="500"><p>
+When the program is running:<br>
+<img src="images\StorageRunSequenceDiagram.png" width="500"><p>
+
+### Commands component
+
+**API**: `Command.java`
+
+{UML class diagram}
+
+The `Command` component,
+* can execute different commands, such as adding category, adding event, deleting category, deleting event, viewing category, viewing event
+* depends on `CategoryList.java`, `CategoryCommand.java`, `Event.java`, `Parser.java` to execute the commands.
+
+### Parser component
+
+**API**: `Parser.java`
+
+{UML class diagram}
+
+The `Parser` component,
+* can parse the user input and process it to the correct format
+* depends on `CategoryList.java`, `CategoryCommand.java`, `Event.java`, `Command.java` to execute the commands.
+
+## Implementation
+
+### Parser component
+
+The Parser class contains several private methods, each of which is responsible for creating a specific type of Command
+object based on the user input. Each method takes in an array of strings as an argument, which contains 
+the user input split into keyword and the content. The method then checks the first word in the array to determine which
+type of Command object to create. If the first word matches a specific keyword (e.g. "bye"), the corresponding Command
+object is created and returned. If the keyword is not recognized, an InvalidCommandException is thrown. Some methods 
+also perform additional checks on the input string to ensure that it is formatted correctly. If the input is in correct
+format, the corresponding Command object is created and returned. Otherwise, an InvalidCommandException is thrown.
+
+### Commands component
+
+The Command class is an interface that is implemented by all the different types of Command objects. It contains methods
+that are common to all Command objects, such as execute() and isExit(). The execute() method contains the logic to
+perform certain tasks and is called when the Command object is to be executed. The isExit() method is called to 
+check if the Command object is an ExitCommand object, which signals the end of the program.
 
-## Product scope
+### Exceptions component
+
+The Exceptions class contains several types of custom Exception objects that are thrown when the user input is not
+in the correct format. 
+
+### Category component
+
+The components use arraylist to store events for each category and 
+store all categories in a category list.
+
+### Event component
+
+The components implement event class to store the information of each event.
+
+## Appendix A: Product Scope
 ### Target user profile
 
-{Describe the target user profile}
+-------------------------
+<div align="center">
+<img src="images\NUS_Students.png" width="300" />
+</div>
+
+* **Name**: NUS Student
+* **Age**: 18-25 years old
+* **Occupation**: Student
+* **Education**: Currently enrolled in NUS
+* **Income**: Limited income sources (part-time jobs, allowances from parents, etc.)
+* **Technology usage**: Tech-savvy and comfortable using a CLI-based application
+* **Interests**: Campus life, budgeting, saving, optimizing spending
+* **Financial goals**: Prioritize spending, cut down on unnecessary expenses, improve financial health
+* **Challenges**: Limited income, lack of financial knowledge, lack of financial discipline
+* **Needs**: A simple, easy-to-use application to help manage expenses and track spending habits
+
+Overall, NUS Student is a financially-conscious individual who wants to prioritize spending and save for the future while 
+enjoying a good campus life. They are comfortable with technology and prefer an efficient and easy-to-use tool like MoneyMind 
+to manage their finances. They are interested in tracking their expenses by category and exploring new ways to 
+optimize their spending to achieve their financial goals.
 
 ### Value proposition
 
 {Describe the value proposition: what problem does it solve?}
 
-## User Stories
+## Appendix B: User Stories
+
+| Version | As a ... | I want to ...                                                                                          | So that I can ...                                          |
+|-----|------|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
+| v1.0 | user | **add** an one time expense                                                                            | keep track of how much I spend                             |
+|     | user | **delete** a one time expense                                                                          | ammend the record in case I add the wrong expense          |
+|     | user | **categorize** my expenses into different categories such as food, transportation, entertainment, etc. | better understand where my money is going                  |
+| v2.0 | user | **edit** one time expenses                                                                             | change when I type wrongly |
+|     | user | **search** for specific expenses by keyword or date range                                              | easily find and review my past spending         |
+
+## Appendix C: Non Functional Requirements
+
+1. MoneyMind should work on any mainstream OS as long as it has Java 11 or above installed.
+2. The user is expected to be a fast-typer. MoneyMind is not optimised for users that are not 
+used to CLI applications.
+3. The user is expected to have a good habit of constantly and systematically recording their
+expenses. MoneyMind is not optimised for users that only record their expense on ad-hoc basis.
+4. Other than the above, please enjoy using MoneyMind!
+
+## Appendix D: Glossary
+
+* *budget* - A budget is a financial plan that outlines an individual's or 
+organization's expected income and expenses over a specific period of time.
+In context given, the budget here is scaled down to NUS students' expenses over 
+different categories.
+Budgets can typically include categories for different types of expenses, 
+such as housing, transportation, food, entertainment, and savings.
+* *expense* - An expense is the cost incurred by an organization or individual.
+In context given, the expense here is scaled down to NUS students' spending over
+different events that they are engaged in.
+*  *event* - An event is a specific occurrence of expenses that is planned or occurs.
+It can be a one time expense like buying a pair of sneakers or recurring expenses like
+electricity bills.
+*  *category* - A category is a group of events that are related to each other. For example,
+food, transportation, entertainment, etc.
+*  *one time expense* - An expense that occurs only once.
+*  *recurring expense* - An expense that occurs repeatedly, in the context of MoneyMind, the
+frequency is set to monthly.
+
+## Appendix E: Instructions for Manual Testing
+
+First type 
+```
+category food b/200
+```
+
+Expected: 
+```
+New category added: food
+```
+
+Then type 
+```
+event buy salad e/12
+```
+
+Expected: 
+```
+Please select the category you want to add the event to: 
+```
+
+Then type 
+```
+1
+```
+
+Expected: 
+```
+New event added: buy salad
+```
+
+Then type 
+```
+edit c/food e/1
+```
+
+Expected: 
+```
+The current event expense for buy salad is: 12
+Your new expense would be: 
+```
+
+Then type 
+```
+100
+```
+
+Expected: 
+```
+Ok, the new expense is now changed to: 100
+```
+
+Then type 
+```
+view
+```
+
+Expected: 
+```
+1.food (budget: 200)
+buy salad [expense]100
+```
 
-|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|
+Then type 
+```
+delete c/food
+```
 
-## Non-Functional Requirements
+Expected: 
+```
+Category deleted: food
+```
 
-{Give non-functional requirements}
+Then type 
+```
+view
+```
 
-## Glossary
+Expected: 
+```
+There are no categories to view
+```
 
-* *glossary item* - Definition
+Then type 
+```
+bye
+```
 
-## Instructions for manual testing
+Expected: 
+```
+Bye. Hope to see you again soon!
+```
 
-{Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+</div>

docs/README.md

@@ -1,8 +1,8 @@
-# Duke
+# MoneyMind
 
-{Give product intro here}
+MoneyMind is a desktop application for managing your finances, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, MoneyMind can get your finance management tasks done faster than traditional GUI apps.
 
-Useful links:
+To get to know more about MoneyMind, here are the  useful links:
 * [User Guide](UserGuide.md)
 * [Developer Guide](DeveloperGuide.md)
 * [About Us](AboutUs.md)