[CS2113T-T12-2] PayMeBack

.github/ISSUE_TEMPLATE/bug-report--customised-template-.md

@@ -0,0 +1,26 @@
+---
+name: Bug report (Customised Template)
+about: Template to provide bug reports
+title: ''
+labels: type.Bug
+assignees: ''
+
+---
+
+**Bug Description**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual Behaviour**
+Provide any output of what actually happened, and the stack trace if possible.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug-report--github-template-.md

@@ -0,0 +1,38 @@
+---
+name: Bug report (Github Template)
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/user-stories.md

@@ -0,0 +1,10 @@
+---
+name: User Stories
+about: Blank template (with some tags set) for adding new user stories
+title: ''
+labels: type.Story
+assignees: ''
+
+---
+
+

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+src/main/java/seedu/duke/Mytest.java
+trips.json

README.md

@@ -63,3 +63,5 @@ Steps for publishing documentation to the public:
 1. Scroll down to the `GitHub Pages` section.
 1. Set the `source` as `master branch /docs folder`.
 1. Optionally, use the `choose a theme` button to choose a theme for your documentation.
+
+*temp change*

build.gradle

@@ -12,6 +12,7 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+    implementation group: 'com.google.code.gson', name: 'gson', version: '2.8.8'
 }
 
 test {
@@ -41,6 +42,7 @@ checkstyle {
     toolVersion = '8.23'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -2,8 +2,9 @@
 
 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)
+
+![](https://via.placeholder.com/100.png?text=Photo) | Lee Yi Kai | [Github](https://github.com/leeyikai) | [Portfolio](docs/team/leeyikai.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Xi Yuan | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lee Keng Yong Joshua | [Github](https://github.com/joshualeeky) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lee Qi An | [Github](https://github.com/itsleeqian) | [Portfolio](docs/team/qian.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Liang Yuzhao | [Github](https://github.com/yeezao) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -2,11 +2,91 @@
 
 ## Acknowledgements
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+Third party library used: GSON under Apache License 2.0
 
-## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+## Design 
+
+### Architecture
+The ***Architecture Diagram*** given above explains the high-level design of the App.
+
+Given below is a quick overview of main components and how they interact with each other.
+
+**Main components of the architecture**
+
+`Main` is responsible for initialising the different components correctly at app launch, and connecting them with one another.
+
+`Commons` represents a collection of classes used by multiple components.
+The major classes in `Commons` are `Trip`, `Expense` and `Person`.  
+Further elaboration on these classes will be in the following sections later.
+
+The remaining components are as follows:
+
+`Ui`: The User Interface of the App
+`Parser`: The command executor
+`Storage`: Holds the data of the App in memory, and also reads and writes data to the hard disk
+
+**How the architecture components interact with one another**
+
+The ***Sequence Diagram*** below shows how the components interact with each other.
+For this particular interaction, the user has issued the command
+`create` with the correct input parameters.
+
+The sections below provide more details of the components and classes in them.
+
+
+### `Trip` Class
+
+The `Trip` class contains attributes storing the details of trips added by the user, 
+and is a container class for the expenses (each expense being represented by an 
+instance of the `Expense` class) and persons (each person being represented by an 
+instance of the `Person` class) tagged to the trip.
+
+A trip is created when the `Parser` class calls its `executeCreate()` method to instantiate 
+a new instance of `Trip`. The newly-created trip is then added to the `ArrayList<Trip>` 
+in the Storage class
+
+Although the program is able to store zero trips, in order for it to work at any appreciable level,
+there must be at least one trip added by the user (either through input or through loading from the
+save file) in order for any other features to be available. If there are no trips added, the program 
+will repeatedly prompt the user to add a new trip.
+
+### `Person` Class
+The  Person Class,
+* Represents an individual that participated in an expense or a whole trip.
+* A user-defined amount of `Person` objects will be created by the user during the create function of the `Trip` Class.
+* Every time an object is created of the `Expense` Class, the user may define the people who were involved in the expense, however the people who are added to the expense must be already a `Person` object in the `Trip` object that the expense was made.
+* One `Person` object who was involved in the expense will then be appointed as the payer of the group, the user will then have to indicate how much (in foreign currency) each of the participating persons spent for that particular expense. This is then stored and updated in each of the respective `Person` object’s `moneyOwed` HashMap,  where a positive double refers to how much the person owes the respective Person object (i.e. the key of the HashMap) and a negative double refers to how much the Person object (i.e. the key of the HashMap) owes to that instance of the Person object.
+  * Example: If the HashMap = {person2 = 22, person3 = -11} in the person1 object, then person1 owes person2 $22 and person3 owes person1 $11.
+
+### `Ui` Class
+
+The `Ui` class handles everything that the user sees, which includes exception handling messages, outputs to users and feedback.
+
+`Ui` class consists of multiple print methods, where some are listed above in the UML diagram. `Ui` depends on other classes, 
+such as `Storage`, `Parser`, `Trip` and `Expense` to obtain information stored in these classes.
+
+The `Ui` class,
+- Obtains information from Storage, Parser, Trip and Expense components.
+- Prints the information through the terminal.
+
+### `Parser` Class
+
+The `Parser` class handles all input and executes the corresponding actions based on the user input. 
+It consists of methods that will execute most commands that is crucial to the functionality of our program.
+
+`Parser` depends on other classes for the respective inputs and outputs.`Duke` calls the `Parser` class in order for the 
+necessary commands to be executed. However, not all functionality is stored here. Rather, `Parser` acts like an interface 
+that handles all the logic required to pass in the correct information into the different classes to execute.
+
+The `Parser` class
+- Contains the logic to check user commands and break the input into the necessary contents for other classes to use
+
+### `Expense` Class
+The `Expense` class deals with most functionalities related to adding an expense inside a trip. The sequence diagram below shows how an expense is initialised.
+![](../Resources/Expense%20Sequence%20Diagram.jpeg)
+
+When `Parser` calls the `executeExpense` method, it creates an expense object, and also calls the `promptDate` method to set that expense object’s date. `promptDate` calls `isDateValid` to validate user input.
 
 
 ## Product scope