nus-cs2113-AY2324S1 · DextheChik3n · Nov 12, 2023 · Nov 12, 2023 · Nov 12, 2023 · Nov 12, 2023
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,6 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+META-INF/MANIFEST.MF
+data/
+
diff --git a/build.gradle b/build.gradle
@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.cafectrl.CafeCtrl")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("cafectrl")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/docs/AboutUs.md b/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) | Shanice  | [Github](https://github.com/ShaniceTang) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Naychi  | [Github](https://github.com/NaychiMin/tp) | [Portfolio](docs/team/johndoe.md)
+![](https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.scmp.com%2Fweek-asia%2Fpolitics%2Farticle%2F3095228%2Fmalaysia-najibs-cheesy-super-ring-jibe-comes-back-bite-him-after&psig=AOvVaw2ohFjBBhoZxtARfOKEnTXE&ust=1696586245977000&source=images&cd=vfe&opi=89978449&ved=0CBEQjRxqFwoTCJiboLbS3oEDFQAAAAAdAAAAABAE) |  Zi Yi   | [Github](https://github.com/ziyi105) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Dexter Hoon | [Github](https://github.com/DextheChik3n) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Chua Zhong Heng | [Github](https://github.com/Cazh1/tp) | [Portfolio](docs/team/johndoe.md)
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
-# Duke
+# CafeCTRL
 
-{Give product intro here}
+CafeCTRL aims to optimize managing of inventory and cash flow in a restaurant. Our CLI platform empowers Café proprietors to streamline inventory and menu management.
 
 Useful links:
 * [User Guide](UserGuide.md)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -2,41 +2,324 @@
 
 ## Introduction
 
-{Give a product intro}
+CafeCTRL aims to optimize managing of inventory and cash flow in a restaurant. Our CLI platform empowers Café proprietors to streamline inventory and menu management.
+
 
 ## Quick Start
+1. Ensure that you have Java `11` or above installed. 
+2. Down the latest version of `CafeCtrl` from [here](https://github.com/AY2324S1-CS2113-T17-2/tp/releases).
+3. Copy the file to the folder you want to use as the home folder for your Cafe Manager CLI Application.
+4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar tp.jar` command to run the application.
+5. If the setup is correct, you should see something like the below as the output:
+```
+Hello! Welcome to CafeCTRL!
+-----------------------------------------------------
+> 
+```
 
-{Give steps to get started quickly}
+## Features 
+> **Notes about command format:**
+> - Words in `UPPER_CASE` are the arguments to be supplied by user. <br>
+    e.g. in add name/NAME, NAME is a parameter that can be used as add name/Chicken.
+> - Parameters need to be in the exact format as specified. <br>
+    e.g. `add name/DISH_NAME price/PRICE ingredient/INGREDIENT1_NAME qty/INGREDIENT1_QTY`,<br> `name/` must come before `price/`.
+> - Items in square brackets with … can be used multiple times including zero times. <br>
+    e.g. `add name/DISH_NAME price/PRICE ingredient/INGREDIENT1_NAME qty/INGREDIENT1_QTY [, ingredient/INGREDIENT2_NAME qty/INGREDIENT2_QTY, ...]` <br>
+    can be used as <br>
+    `add name/Christmas Ham price/50.00 ingredient/Ham qty/1000g`<br>
+    or as <br>
+    `add name/chicken rice price/2.00 ingredient/rice qty/100g, ingredient/chicken qty/200g, ingredient/garlic qty/100g`
+> - Extraneous parameters for commands that do not take in parameters (such as `help`, `list_menu`, `bye`) will be ignored. <br>
+    e.g. if the command specifies `help 123`, it will be interpreted as `help`.
 
-1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+### Viewing help : `help`
+Shows a message explaining how to use all the commands
 
-## Features 
+Format: `help`
+Output:
+```
+These are all the commands I recognise: 
 
-{Give detailed description of each feature}
+(- Words in UPPER_CASE are the parameters to be supplied by the user.
+e.g. in add name/NAME, NAME is a parameter that can be used as add name/Chicken.
+- Parameters in [] are optional.)
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+Command Format:
+add name/DISH_NAME price/DISH_PRICE ingredient/INGREDIENT1_NAME qty/INGREDIENT1_QTY[, ingredient/INGREDIENT2_NAME, qty/INGREDIENT2_QTY...]
+(Items in square brackets [] are optional)
+Example:
+add name/chicken rice price/3.00 ingredient/rice qty/200g, ingredient/chicken qty/100g
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+list_ingredients: Lists out the ingredients needed along with the quantity for a specific dish.
+Parameters: INDEX
+Example: list_ingredients 1
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+To list out all dishes on the menu: list_menu
 
-Example of usage: 
+To delete a menu item: delete DISH_INDEX
+Example: delete 1
 
-`todo n/Write the rest of the User Guide d/next week`
+edit_priceTo edit price of a menu item: edit_price index/DISH_INDEX price/NEW_PRICE
+Example: edit_price index/1 price/4.50
+```
+<!---@@author DextheChik3n--->
+### Adding a dish : `add`
+Adds a dish consisting of its ingredients to the menu
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+Format: `add name/DISH_NAME price/PRICE ingredient/INGREDIENT1_NAME qty/INGREDIENT1_QTY[, ingredient/INGREDIENT2_NAME qty/INGREDIENT2_QTY, ...]`
 
-## FAQ
 
-**Q**: How do I transfer my data to another computer? 
+* The `PRICE` must be a positive 2 decimal place number.
+* The `IMGREDIENT_QTY` must contain the unit ml or g specifically.
+  * e.g. `qty/50g` or `qty/1000ml`
 
-**A**: {your answer here}
+Example:
+```
+> add name/chicken rice price/2.00 ingredient/rice qty/100g, ingredient/chicken qty/200g, ingredient/soup qty/50ml
+You have added the following dish...
+Dish Name: chicken rice
+Dish Price: $2.00
+chicken rice Ingredients: 
+rice - 100g
+chicken - 200g
+soup - 50ml
+```
 
-## Command Summary
+<!---@@author Cazh1--->
+### Listing all menu items : `list_menu`
+Shows a list of all dishes on the menu
+
+Format: `list_menu`
+
+Example:
+```
++-----------------------------------------+
+| Ah, behold, the grand menu of delights! |
++--------------------------+--------------+
+| Dish Name                |  Price       |
++--------------------------+--------------+
+| 1. chicken rice          |  $2.50       |
+| 2. chicken curry         |  $4.30       |
++-----------------------------------------+
+```
+
+<!---@@author NaychiMin--->
+### Listing ingredients needed for the selected dish : `list_ingredients`
+Lists out the ingredients needed along with the quantity for a specific dish
+
+Format: `list_ingredients DISH_INDEX`
+
+Example:
+- list followed by list_ingredients 1 lists the ingredients of the 1st dish on the menu
+```
+chicken salad Ingredients: 
+pasta - 100g
+chicken - 200g
+lettuce - 200g
+tomatoes - 100g
+feta cheese - 20g
+-----------------------------------------------------
+```
+
+
+list followed by list_ingredients 1 lists the ingredients of the 1st dish on the menu
+
+<!---@@author ShaniceTang--->
+### Deleting a menu item : `delete`
+Deletes a specific dish from the menu
+
+Format: `delete DISH_INDEX`
+
+* Deletes the dish at the specified DISH_INDEX
+* The index refers to the index number shown in the menu list 
+* The index must be a positive integer
+
+Example: `delete 1`
+
+Output:
+```
+Okay! chicken rice is deleted! :)
+```
+
+<!---@@author ziyi105--->
+### Editing price of menu item : `edit_price`
+Edits the price of an existing dish on the menu
+
+Format: `edit_price index/DISH_INDEX price/NEW_PRICE`
+
+Example: `edit_price index/1 price/4.50`
+
+Output: 
+```
+Price modified for the following dish: 
+Chicken rice - $4.50
+```
+
+<!---@@author ShaniceTang--->
+### Viewing the total stock of ingredients : `view_stock`
+Displays the available stock of all the ingredients found in the pantry
+
+Format: `view_stock`
+
+Output:
+```
+You have the following ingredients in pantry:
+Ingredients		Qty
+chicken			500g
+milk			1000ml
+```
+
+
+### Buying an ingredient : `buy_ingredient`
+Adds one or more ingredients to the pantry
+
+Format: `buy_ingredient ingredient/INGREDIENT1_NAME qty/INGREDIENT1_QTY[, ingredient/INGREDIENT2_NAME qty/INGREDIENT2_QTY, ...]`
+
+Example: `buy_ingredient ingredient/chicken qty/500g, ingredient/milk qty/1000ml`
+
+Output:
+```
+Added to stock:
+Ingredient: chicken		Qty: 500g
+Ingredient: milk		Qty: 1000ml
+```
+
+
+
+### Showing all sales : `show_sales`
+Displays the dishes sold and total sales for each from Day 1 to the current day that 
+the cafe is operating on.
+
+Format: `show_sales`
+
+Example: `show_sales`
+
+Output:
+- show_sales lists the dishes sold along with the total sales for every operating day of the cafe.
+```
+Day 1:
+Dish Name            Dish Qty   Total Cost Price    
 
-{Give a 'cheat sheet' of commands here}
+chicken rice         4          12.0                 
+
+Total for day: $12.00
+
+Day 2:
+Dish Name            Dish Qty   Total Cost Price    
+
+chicken chop         5          21.0    
+
+chicken rice         3          9.0                
+
+Total for day: $30.00
+
+```
+
+
+### Showing sales for a chosen day : `show_sale`
+Displays the dishes sold along with the total sales for any chosen day.
+
+Format: `show_sale day/DAY_TO_DISPLAY`
+
+Example: `show_sale day/1`
+
+Output:
+- show_sale day/1 lists the dishes sold along with the total sales for day 1.
+```
+Day 1:
+Dish Name            Dish Qty   Total Cost Price    
+
+chicken rice         4          12.0                 
+
+Total for day: $12.00
+```
+
+<!---@@author Cazh1--->
+### Adding an order : `add_order`
+Adds an order consisting of dishes off the menu to an order list
+
+Format: `add_order name/DISH_NAME qty/DISH_QTY`
+
+Example:
+```
+> add_order name/chicken rice qty/2
+I'm busy crafting your selected dish in the virtual kitchen of your dreams. Bon appétit!
+-----------------------------------------------------
+Order is ready!
+Total order cost: $5.00
+-----------------------------------------------------
+Listed below are the availability of the dishes for the next order!
+Dish: chicken rice
+Available Dishes: 8
+-----------------------------------------------------
+Dish: chicken curry
+Available Dishes: 4
+```
+* The `DISH_QTY` must be a positive integer number.
+
+Adds an order to the current business day
+
+Format: `add_order name/DISH_NAME qty/QUANTITY`
+
+Example: `add_order name/chicken rice qty/2`
+
+Output:
+```
+I'm busy crafting your selected dish in the virtual kitchen of your dreams. Bon appétit!
+Is order completed?: true
+Total orderList cost: $4.00
+```
+
+
+### Returning to the previous day: `previous_day`
+
+Goes back to the previous business day
+
+Format: `previous_day`
+
+Output:
+```
+Sure thing! Let's rev up the virtual DeLorean and take a spin to the previous day. Buckle up, it's time to hit that rewind button!
+Today is Day 1
+```
+
+### Advancing to the next day: `next_day`
+
+Proceeds to the next business day
+
+Format: `next_day`
+
+Output:
+```
+Prepare for liftoff! We're about to fast-forward to the next day. Hold onto your hats; here we go!
+Today is Day 2
+```
+<!---@@author--->
+
+### Exiting the program : `bye`
+Exits the program.
+
+Format: `bye`
+
+## Known Issues
+- The application is unable to read the data text files if they have been edited directly in the wrong decoding format
+- For edit price command, special characters can be entered in the price argument
+
+## Command Summary
+| Action                    | Format, Examples                                                                                                                                                                                                                                       |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Add**                   | `add name/DISH_NAME price/PRICE ingredient/INGREDIENT1_NAME qty/INGREDIENT1_QTY [, ingredient/INGREDIENT2_NAME qty/INGREDIENT2_QTY, ...]`<br><br/>Example:<br/>`add name/chicken rice price/3.00 ingredient/rice qty/50g, ingredient/chicken qty/100g` |
+| **List Menu**             | `list_menu`                                                                                                                                                                                                                                            |
+| **List Ingredients**      | `list_ingredients DISH_INDEX`<br/><br/>Example:<br/>`list_ingredients 1`                                                                                                                                                                               |
+| **Delete**                | `delete DISH_INDEX`<br/><br/>Example:<br/>`delete 1`                                                                                                                                                                                                   |
+| **Edit Price**            | `edit_price index/DISH_INDEX price/NEW_PRICE`<br/><br/>Example:<br/>`edit_price index/1 price/4.50`                                                                                                                                                    | |
+| **Show Sale**             | `show_sales`                                                                                                                                                                                                                                           |
+| **Show Sale by Day**      | `show_sale day/DAY_TO_DISPLAY` <br/><br/>Example:<br/>`show_sale day/ 1`                                                                                                                                                                               |
+| **View Ingredient Stock** | `view_stock`                                                                                                                                                                                                                                           |
+| **Buy Ingredients**       | `buy_ingredient ingredient/INGREDIENT1_NAME qty/INGREDIENT1_QTY[, ingredient/INGREDIENT2_NAME qty/INGREDIENT2_QTY, ...]`<br/><br/>Example<br/>`buy_ingredient ingredient/chicken qty/500g, ingredient/milk qty/1000ml`                                 |
+| **Add Order**             | `add_order name/DISH_NAME qty/QUANTITY`<br/><br/>Example:<br/>`add_order name/chicken rice qty/2`                                                                                                                                                      |
+| **Previous Day**          | `previous_day`                                                                                                                                                                                                                                         |
+| **Next Day**              | `next_day`                                                                                                                                                                                                                                             |
+| **Help**                  | `help`                                                                                                                                                                                                                                                 |
+| **Exit Program**          | `bye`                                                                                                                                                                                                                                                  |
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`