[CS2113-T13-4] SuperTracker

.gitignore

@@ -15,3 +15,10 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+# Log files
+supertracker.log
+supertracker.log.lck
+
+# Data files
+/data/

build.gradle

@@ -29,18 +29,19 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("supertracker.SuperTracker")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("SuperTracker")
     archiveClassifier.set("")
 }
 
 checkstyle {
     toolVersion = '10.2'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,11 @@
 # 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) | Sim Jing Jie Ryan | [Github](https://github.com/rismm) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Tay Wen Duan David | [Github](https://github.com/dtaywd) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Timothy Lau | [Github](https://github.com/TimothyLKM) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Sim Jun Hong | [Github](https://github.com/awesomesjh) | [Portfolio](docs/team/johndoe.md)
+![](team/vimal-face.jpg) | Vimalapugazhan Purushothaman | [Github](https://github.com/vimalapugazhan) | [Portfolio](docs/team/johndoe.md)
+

docs/README.md

@@ -1,6 +1,7 @@
-# Duke
+# SuperTracker
 
-{Give product intro here}
+SuperTracker is a desktop app for managing a supermarket’s inventory, 
+optimized for use via a Command Line Interface (CLI).
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/UserGuide.md

@@ -1,42 +1,278 @@
 # User Guide
 
-## Introduction
+## SuperTracker
 
-{Give a product intro}
+SuperTracker is a desktop app for managing a supermarket's inventory,
+optimized for use via a Command Line Interface (CLI).
+
+- [Quick Start](#quick-start)
+- [Features](#features-)
+  - [Create a new item: `new`](#create-a-new-item-new)
+  - [Delete an item: `delete`](#delete-an-item-delete)
+  - [Increase quantity: `add`](#increase-quantity-add)
+  - [Decrease quantity: `remove`](#decrease-quantity-remove)
+  - [Update an item: `update`](#update-an-item-update)
+  - [List all items: `list`](#list-all-items-list)
+  - [Prints report: `report`](#Prints report)
+  - [Quit the program: `quit`](#quit-the-program-quit)
+  - [Saving inventory data](#saving-inventory-data)
+  - [Loading inventory data](#loading-inventory-data)
+  - [Editing the data file](#editing-the-data-file)
+
+--------------------------------------------------------------------------------------------------------------------
 
 ## Quick Start
 
-{Give steps to get started quickly}
+1. Ensure that you have Java 11 or above installed in your Computer.
+2. Download the latest `SuperTracker.jar` from [here](https://github.com/AY2324S2-CS2113-T13-4/tp/releases).
+3. Open a command terminal, cd into the folder you put the jar file in, and use the `java -jar SuperTracker.jar` command to run the application.
+4. Type the command in the command box and press Enter to execute it.
+5. Refer to the [Features](#features-) below for details of each command and its format.
 
-1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+--------------------------------------------------------------------------------------------------------------------
 
 ## Features 
 
-{Give detailed description of each feature}
+> Notes about the command format:
+> - Words in uppercase are parameters to be specified by the user
+>   - e.g. in `add n/NAME q/QUANTITY`, `NAME` and `QUANTITY` are parameters which can be used as `add n/cheese q/100`
+> - Items in square brackets are optional
+>   - e.g. `list [q/] [p/]` can be used as `list q/`, `list p/`, `list` etc.
+> - Parameters can be in any order
+>   - e.g. if the command specifies `n/NAME q/QUANTITY`, `q/QUANTITY n/NAME` is also acceptable
+> - Commands that do not take in parameters will ignore any additional parameters input by the user
+>   - e.g. if the command specifies `quit now`, it will be interpreted as `quit`
+> - If the command has multiple of the same parameters, it uses the first occurrence of that parameter
+>   - e.g. if the command specifies `new n/Milk q/100 p/5 n/Cheese`, it will be interpreted as `new n/Milk q/100 p/5`
+> - If any of the compulsory parameters are empty an error is thrown
+
+<br>
+
+### Create a new item: `new`
+Create a new item in the inventory
+
+Format: `new n/NAME q/QUANTITY p/PRICE [e/EXPIRY_DATE]`
+
+- `NAME` is case-insensitive
+  - e.g. `Cheese` will be interpreted as `cheese`
+- If `NAME` already exists in the inventory, use the **update** command instead
+- `QUANTITY` must be a non-negative integer
+  - e.g. 1, 10, 100
+- `PRICE` must be a non-negative integer or decimal number
+  - e.g. 1, 0.20, 12.3, 12.345
+- If the `PRICE` given has more than 2 decimal places, it will be rounded off to the nearest 2 decimal places
+  - e.g. 12.345 ≈ 12.35
+- `EXPIRY_DATE` must be a valid non-negative date in the format of `dd-mm-yyyy`
+  - e.g. 05-10-2054, 16-07-2245
+
+Example: `new n/Milk q/100 p/5` `new n/Banana p/1.23 q/50 e/15-06-2113`
+```
+Milk has been added to the inventory!
+Quantity: 100
+Price: $5.00
+```
+```
+Banana has been added to the inventory!
+Quantity: 50
+Price: $1.23
+Expiry Date: 15/06/2113
+```
+
+<br>
+
+### Delete an item: `delete`
+Delete an item from the inventory
+
+Format: `delete n/NAME`
+- `NAME` is case-insensitive
+  - e.g. `Cheese` will be interpreted as `cheese`
+- If `NAME` does not exist in the inventory, an error would be thrown
+
+Example: `delete n/Milk`
+```
+Milk has been deleted!
+```
+
+<br>
+
+### Increase quantity: `add`
+Increase the quantity of an item
+
+Format: `add n/NAME q/QUANTITY`
+- `NAME` is case-insensitive
+  - e.g. `Cheese` will be interpreted as `cheese`
+- If `NAME` does not exist in the inventory, an error would be thrown
+- `QUANTITY` must be a non-negative integer
+  - e.g. 1, 10, 100
+
+Example: `add n/Milk q/10`
+```
+10 Milk added to inventory!
+Quantity: 110
+```
+
+<br>
+
+### Decrease quantity: `remove`
+Decrease the quantity of an item
+
+Format: `remove n/NAME q/QUANTITY`
+- `NAME` is case-insensitive
+  - e.g. `Cheese` will be interpreted as `cheese`
+- If `NAME` does not exist in the inventory, an error would be thrown
+- `QUANTITY` must be a non-negative integer
+  - e.g. 1, 10, 100
+- If `QUANTITY` exceeds the current quantity of the item, the new quantity would be set to 0
+
+Example: `remove n/Milk q/10`
+```
+10 Milk removed from inventory!
+Quantity: 90
+```
+
+<br>
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+### Update an item: `update`
+Update the quantity and/or price of an item
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Format: `update n/NAME [q/NEW_QUANTITY] [p/NEW_PRICE] [e/NEW_EXPIRY_DATE]`
+- `NAME` is case-insensitive
+  - e.g. `Cheese` will be interpreted as `cheese`
+- If `NAME` does not exist in the inventory, an error would be thrown
+- `NEW_QUANTITY` must be a non-negative integer
+  - e.g. 1, 10, 100
+- `NEW_PRICE` must be a non-negative integer or decimal number
+  - e.g. 1, 0.20, 12.3, 12.345
+- If the `NEW_PRICE` given has more than 2 decimal places, it will be rounded off to the nearest 2 decimal places
+  - e.g. 12.345 ≈ 12.35
+- `NEW_EXPIRY_DATE` must be a valid non-negative date in the format of `dd-mm-yyyy`
+  - e.g. 05-10-2054, 16-07-2245
+- At least one of the optional parameters must be present
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+Example: `update n/Milk q/200 p/10 e/15-06-2113`
+```
+Milk has been successfully updated!
+Quantity: 200
+Price: $10.00
+Expiry Date: 15/06/2113
+```
 
-Example of usage: 
+<br>
 
-`todo n/Write the rest of the User Guide d/next week`
+### List all items: `list`
+List all unique items in the inventory.
+Output will be printed to the terminal and each row will contain the name of each item.
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+Format: `list [q/] [p/] [e/] [sq/] [sp/] [se/] [r/]`
+- `q/` will list the quantity of each item in each row
+- `p/` will list the price of each item in each row
+- `e/` will list the expiry date of each item in each row if it contains a valid expiry date
+- In each row, quantity, price and expiry date will be printed in the same order as the flags
+  - e.g. if the command specifies `list p/ q/ e/`, the quantity will be printed first followed by price and lastly expiry date
+- `sq/` will list the items in order of ascending quantity
+- `sp/` will list the items in order of ascending price
+- `se/` will list the items in order of ascending date and items with no date are displayed at the bottom
+- If the command has multiple sorting parameters, the list will be sorted according to the first sorting parameter
+  - e.g. if the command specifies `list sq/ sp/ se/`, list will be sorted in order of ascending quantity
+- If the command has no sorting parameters, the list will be sorted in ascending alphabetical order (A-Z) by default
+- `r/` will reverse the order of the list
+
+Example: `list q/ p/ e/ sp/ r/`
+```
+There are 3 unique items in your inventory:
+1. Name: Milk    Quantity: 100    Price: $5.00
+2. Name: Juice    Quantity: 300    Price: $4.00    Expiry Date: 12/03/2025
+3. Name: Cheese    Quantity: 200    Price: $3.00
+```
+
+<br>
+
+### Prints report: `report`
+Lists all items that match the requirements of the report.
+
+There are 2 types of reports in this iteration:
+1. **low stock** - lists all stocks that are below a specified threshold that the user provides
+2. **expiry** - lists all stocks that are within a week of expiring or has already expired
+
+Output will be printed to the terminal and each row will contain the name of each item.
+If the report type is **low stock**, the current quantity for each item would be listed and if the report type is 
+**expiry**, the expiry date for each item would be listed as well.
+
+Format: `report r/REPORT_TYPE [t/THRESHOLD_VALUE]`
+- `r/` parameter that specifies the type of report. e.g. **low stock** or **expiry**
+- `t/` parameter that specifies the threshold value to be compared to for **low stock report**. 
+All items below the threshold value would be listed out.
+
+**Note**: If report type is **low stock** threshold value must be **included**. However, if report type is **expiry** 
+threshold value must be **excluded**.
+
+Example: `report r/low stock` `report r/expiry`
+```
+There are 3 items low on stocks!
+1. Name: orange
+   Current Quantity: 10
+2. Name: banana
+   Current Quantity: 30
+3. Name: apple
+   Current Quantity: 20
+```
+```
+There are 2 items close to expiry!
+1. Name: orange
+  Expiry Date: 08-04-2024
+2. Name: apple
+  Expiry Date: 12-12-2016
+```
+
+<br>
+
+### Quit the program: `quit`
+Quits the program
+
+Format: `quit`
+
+<br>
+
+### Saving inventory data
+Inventory data in the program is saved to the hard disk in the file path `./data/` in the same directory that
+the `SuperTracker.jar` file is in. Data will be saved automatically after any command that changes the item data in the inventory.
+
+<br>
+
+### Loading inventory data
+Data that has been saved to the hard disk will be loaded and read by the program each time it is launched. 
+If there is no data file, the program will the loading process.
+
+<br>
+
+### Editing the data file
+Inventory data of the `SuperTracker` program is stored in a text file `items.txt` in the path `./data/` relative to 
+the directory the `SuperTracker.jar` file is in. Users can edit and update the inventory data directly through the data file
+if they would like to do so.
+> Note: Edit the data file at your own caution. If the changes made to the data file are in an invalid format, the program
+> will ignore those changes on its next load. The changes will be erased on the next automatic save, so do keep a backup of the data 
+> file before editing.
+
+--------------------------------------------------------------------------------------------------------------------
 
 ## FAQ
 
 **Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
+**A**: Install the app in the other computer and overwrite the empty data file it creates 
+with the file that contains the data of your previous SuperTracker inventory
 
-## Command Summary
+--------------------------------------------------------------------------------------------------------------------
 
-{Give a 'cheat sheet' of commands here}
+## Command Summary
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+Action | Format                                                             | Examples
+--------|--------------------------------------------------------------------|---------------
+**New** | `new n/NAME q/QUANTITY p/PRICE e/EXPIRY_DATE`                      | e.g. `new n/Milk q/100 p/5 e/05-12-2113`
+**Delete**| `delete n/NAME`                                                    | e.g. `delete n/Milk`
+**Add**| `add n/NAME q/QUANTITY`                                            | e.g. `add n/Milk q/10`
+**Remove**| `remove n/NAME q/QUANTITY`                                         | e.g. `remove n/Milk q/10`
+**Update**| `update n/NAME [q/NEW_QUANTITY] [p/NEW_PRICE] [e/NEW_EXPIRY_DATE]` | e.g. `update n/Milk q/200 p/10 e/05-08-2113`
+**List**| `list [q/] [p/] [e/] [sq/] [sp/] [se/] [r/]`                       | e.g. `list q/ p/ sp/ r/`
+**Report**| `report r/REPORT_TYPE [t/THRESHOLD_VALUE]`                         | e.g. `report r/low stock t/10`
+**Quit**| `quit`                                                             | e.g. `quit`