[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](team/Zhao_Lixiuqi.md)
+![](https://via.placeholder.com/100.png?text=Photo) |        Toh Hongfeng        |  [Github](https://github.com/Toh-HongFeng)  | [Portfolio](team/toh-hongfeng.md)
+![](https://via.placeholder.com/100.png?text=Photo) |        Li Mingyuan         |  [Github](https://github.com/mingyuannus)   | [Portfolio](team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |      Nguyen Duc Thang      |     [Github](https://github.com/Mnsd05)     | [Portfolio](team/mnsd05.md)

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)

docs/UserGuide.md

@@ -1,42 +1,197 @@
-# User Guide
+---
+layout: page
+title: user Guide
+---
 
-## Introduction
+<div align="center">
+<h2> MoneyMind User Guide</h2>
+<h3> "Mind your Money" </h3>
+</div>
 
-{Give a product intro}
+Moneymind is a Command Line Interface (CLI) application that helps you manage your personal finances. With Moneymind, you can keep track of your budgets, expenses, and categorize them for better organization.
+
+* Table of Contents
+{:toc}
 
 ## Quick Start
 
-{Give steps to get started quickly}
+1. Download and install Moneymind on your computer and ensure that you have Java 11 or above installed.
+
+2. Ensure you have Java11 or above installed on your computer.
+
+3. Open the terminal and navigate to the directory where Moneymind is installed.
+
+4. Run the following command to start the Moneymind app: `java -jar moneymind.jar`.
 
-1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+5. Type the command in the command box and press Enter to execute.
 
 ## Features 
 
-{Give detailed description of each feature}
+"/" is a special character that is used to start command parameters. Other uses of "/" are not allowed except for t/ in event command
+
+### Add an Event: `event`
+Add an event which is to be recorded by Moneymind. Event must be placed in a category.
+
+Format: `event NAME e/<expense number> [(optional) t/<time>]`
+
+* `NAME` is the name of the event.
+* `<expense number>` is the expense number of the event.
+* `<time>` is the date of the monthly recurring event, in the pattern of "dd/MM/yyyy hh:mm". 
+Invalid patterns are replaced with the current System date.
+* The `t/` parameters is optional.
+* This gives you the flexibility to add a one-time expense or monthly recurring expenses.
+* Monthly recurring expenses will be require the user to update the expense number every month.
+* In the context of this application, the 'MM', 'yyyy', 'hh' and 'mm' in the data format of `<time>` is less important
+as the frequency is set as *monthly*. Hence, whatever valid month input that the user types
+in, the event will always be recorded as a monthly recurring event based on its date.
+To avoid confusion, the user is advised to type in the month and year of the first occurrence of the event
+which they want to record down.
+
+Example of usage:
+
+`event bus travel fee e/2 t/01/01/2020 12:00`
+
+`event bubble tea e/6`
+
+### Add a Category: `category`
+
+Add a category of event  to be recorded on Moneymind.
+
+Format: `category NAME [(optional) b/<budget number>]`
+
+* `NAME` is the name of the category.
+* `<budget number>` is the total amount of budget 
+set to the category of events.
+* The `b/` parameter is optional. If there is no b/, the default budget is set to 0
+
+Example of usage:
+
+`category electricity bill`
+
+`category travel to Thailand b/2000`
+
+### Delete an Event or Category: `delete`
+
+Delete an event or category from Moneymind.
+
+Format: `delete c/<category name> [(optional) e/<event index>]`
+
+* `<category name>` is the name of the category.
+* `<event index>` is the position of the event (1 based).
+* The `e/` parameter is optional so that the user can choose between deleting a single event or the whole category.
+
+Example of usage:
+
+`delete c/electricity bill`
+
+`delete c/food e/1`
+
+### Edit an Event: `edit`
+
+Edit the details of an event on Moneymind.
+
+Format: `edit c/<category name> [(optional) e/<event index>] `
+
+* `<category name>` is the name of the category the user want to edit.
+* `<event index>` is the position of the event that the user want to edit (1 based).
+* The user will be prompted to enter the new details of the event or category
+
+Example of usage:
+
+`edit c/overseas travel e/1`
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+Ok, the current expense for book hotel is: 200;
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Your new expense would be:
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+`100`
 
-Example of usage: 
+Ok, the new expense is now changed to: 100 sgd
 
-`todo n/Write the rest of the User Guide d/next week`
+### View Events in Categories: `view`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+This commands allows the user to view all events in one category or view all categories in moneymind.
+
+Format: `view [(optional) <category name>]`
+
+* `<category name>` is the name of the category that the user wants to view.
+* The user can view all the categories by entering `view` without any category name
+
+Example of usage:
+
+`view food` : view all events in the food category
+
+`view` : view all categories in moneymind
+
+### Search for a Category or Event: `search`
+
+Searches through all categories and and events to find items that contains the provided keyword along with the top 3 categories and events that are similar to the keyword. The results will contain 4 sections:
+1. Matching categories: All categories that contain the provided keyword in their names
+2. Matching events: All events that contain the provided keyword in their names, along with the categories they belong to
+3. Similar categories: Top 3 categories with names that are most similar to the provided keyword
+4. Similar events: Top 3 categories with names that are most similar to the provided keyword, along with the categories they belong to
+
+Format: `search <keyword>`
+
+Example of usage:
+
+`search bill`
+
+### Reminders
+
+When starting up the program, it will remind the user of the 
+upcoming events in the next 5 days.
+
+`Appoaching expenses:`<br>
+`Category_Name has an event: Event_Name in 2 days`<br>
+`Category_Name_2 has an event: Event_Name_2 in 3 days`<br>
+
+### Check the Instruction Menu - 1: `help`
+
+This command allows the user to view the **detailed** instruction menu.
+
+Format: `help`
+
+Example of usage:
+
+`help`
+
+### Check the Instruction Menu - 2: `summary`
+
+This command allows the user to view the **summary** of commands that they can use.
+
+Format: `summary`
+
+Example of usage:
+
+`summary`
+
+### Exit the Program: `bye`
+
+This command allows the user to exit the program.
+
+Format: `bye`
+
+Example of usage:
+
+`bye`
+
+---
 
 ## FAQ
 
-**Q**: How do I transfer my data to another computer? 
+**Q**: Am I able to keep my data after I exit the program?
 
-**A**: {your answer here}
+**A**: Yes. Your data will be saved automatically after you exit the program, and loaded the next time you use the program.
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
-
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* `event` - Add an event to Moneymind
+* `category` - Add a category to Moneymind
+* `delete` - Delete an event or category from Moneymind
+* `edit` - Edit an event in Moneymind
+* `view` - View all events in a category or view all categories in Moneymind
+* `help` - Show the detailed instructions of commands
+* `summary` - Show the summary of commands
+* `search` - Search categories and events given a specific keyword
+* `bye` - Exit the program

docs/diagrams/Architecture.puml

@@ -0,0 +1,24 @@
+@startuml
+!include Style.puml
+!include <office/Users/user>
+!include <office/Concepts/documents>
+!theme cerulean
+
+package " "<<Rectangle>> {
+    class MoneyMind
+    class UI
+    class Storage
+    class Command
+    class Data
+    class Parser
+}
+
+MoneyMind --> UI
+Storage ..> MoneyMind
+Storage --> Data
+Data --> Storage
+MoneyMind --> Parser
+Parser --> Command
+Command --> Data
+
+@enduml

docs/diagrams/ArchitectureSequence.puml

@@ -0,0 +1,58 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+!include style.puml
+title Architecture Sequence Diagram
+
+Actor User as user #crimson
+participant MoneyMind as mm #lightblue
+participant UI as ui #lightpink
+participant Storage as storage #lightgrey
+
+
+
+user -[#crimson]> mm : EventCommand  buy lunch e/10
+activate mm #lightblue
+
+mm -> ps : parseNextCommand()
+activate ps #orange
+
+ps -> ps : createEventCommand()
+activate ps #orange
+create EventCommand
+ps -> EventCommand
+activate EventCommand
+EventCommand --> ps
+deactivate EventCommand
+ps --> ps
+deactivate ps #orange
+ps --> mm
+deactivate ps #orange
+
+mm -> EventCommand : isExit()
+activate EventCommand
+EventCommand --> mm
+deactivate EventCommand
+
+mm -> EventCommand : execute()
+activate EventCommand
+create Data
+EventCommand -> Data
+activate Data
+Data --> EventCommand
+deactivate Data
+EventCommand --> mm
+deactivate EventCommand
+
+mm -> storage : save()
+activate storage #lightgrey
+storage --> mm
+deactivate storage #lightgrey
+
+
+
+
+
+
+
+
+@enduml