[CS2113-W14-1] FitNUS

README.md

@@ -1,64 +1,219 @@
-# Duke project template
-
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
-
-1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
-1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
-   ```
-   > Task :compileJava
-   > Task :processResources NO-SOURCE
-   > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
-   ```
-   Type some word and press enter to let the execution proceed to the end.
-
-## Build automation using Gradle
-
-* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file).
-* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html).
-
-## Testing
-
-### I/O redirection tests
-
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
-
-### JUnit tests
-
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
-* If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
-
-## Checkstyle
-
-* A sample CheckStyle rule configuration is provided in this project.
-* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html).
-
-## CI using GitHub Actions
-
-The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.
-
-## Documentation
-
-`/docs` folder contains a skeleton version of the project documentation.
-
-Steps for publishing documentation to the public: 
-1. If you are using this project template for an individual project, go your fork on GitHub.<br>
-   If you are using this project template for a team project, go to the team fork on GitHub.
-1. Click on the `settings` tab.
-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.
+# FitNUS
+## Project Introduction
+FitNUS is a CLI application that aims to help combat diabetes and the overconsumption of calories, sugar, and
+carbohydrates. Promote healthy lifestyle.
+
+Users are able to track the meals and drinks they have in a day.
+
+## Table of Contents
+<!-- TOC -->
+[1) Features List](#1-features-list)
+* [1.1 Information for users](#11-information-for-users)
+   * [1.1.1 Viewing all commands:** `help`](#111-viewing-all-commands-help-)
+* [1.2 For user to add data](#12-for-user-to-add-data)
+   * [1.2.1 Add a meal eaten: `ate`](#121-add-a-meal-eaten-ate)
+   * [1.2.2 Add a drink: `drink`](#122-add-a-drink-drink)
+   * [1.2.3 Add water: `water`](#123-add-water-water)
+* [1.3 For data retrieval](#13-for-data-retrieval)
+   * [1.3.1 Find the information about a certain meal: `infoMeal`](#131-find-the-information-about-a-certain-meal-infomeal)
+   * [1.3.2 Find the information about a certain drink: `infoDrink`](#132-find-the-information-about-a-certain-drink-infodrink)
+   * [1.3.3 View daily calories consumed: `calories`](#133-view-daily-calories-consumed-calories)
+   * [1.3.4 View daily carbohydrates consumed: `carbs`](#134-view-daily-carbohydrates-consumed-carbs)
+   * [1.3.5 View daily proteins consumed: `protein`](#135-view-daily-proteins-consumed-protein)
+   * [1.3.6 View daily fat consumed: `fat`](#136-view-daily-fat-consumed-fat)
+   * [1.3.7 View daily sugar consumed: `sugar`](#137-view-daily-sugar-consumed-sugar)
+   * [1.3.8 View daily fiber consumed: `fiber`](#138-view-daily-fiber-consumed-fiber)
+   * [1.3.9 View daily water consumption: `viewWater`](#139-view-daily-water-consumption-viewwater)
+* [1.4 For listing arrays](#14-for-listing-arrays)
+   * [1.4.1 List meal intake: `listMeals`](#141-list-meal-intake-listmeals)
+   * [1.4.2 List drink intake: `listDrinks`](#142-list-drink-intake-listdrinks)
+   * [1.4.3 List entire food intake for the day: `listEverything`](#143-list-entire-food-intake-for-the-day-listeverything)
+* [1.5 For editing existing data](#15-for-editing-existing-data)
+   * [1.5.1 Edit an existing meal after inserted: `editMeal`](#151-edit-an-existing-meal-after-inserted-editmeal)
+   * [1.5.2 Edit an existing drink after inserted: `editDrink`](#152-edit-an-existing-drink-after-inserted-editdrink)
+   * [1.5.3 Edit water intake after inserted: `editWater`](#153-edit-water-intake-after-inserted-editwater)
+* [1.6 For deleting data](#16-for-deleting-data)
+   * [1.6.1 Delete certain meal entry: `deleteMeal`](#161-delete-certain-meal-entry-deletemeal)
+   * [1.6.2 Delete certain drink entry: `deleteDrink`](#162-delete-certain-drink-entry-deletedrink)
+* [1.7 For clearing data](#17-for-clearing-data-)
+   * [1.7.1 Clear all entries: `clear`](#171-clear-all-entries-clear)
+* [1.8: Exit program](#18-exit-program)
+   * [1.8.1 Exit the app: `exit`](#181-exit-the-app-exit)
+<!-- TOC -->
+
+## 1) Features List
+### 1.1 Information for users
+### 1.1.1 Viewing all commands:** `help`
+Shows a list of all possible command inputs.  
+**Format**: help  
+**Sample Input**: help  
+**Expected Output**:  
+here's all the valid commands i recognise:
+- Add a meal eaten: ate m/MEAL s/SERVING_SIZE
+- Add a drink: drink d/DRINK s/SERVING_SIZE
+- Add water: water s/SERVING_SIZE
+- Find the information about a certain meal: infoMeal MEAL
+- Find the information about a certain drink: infoDrink DRINK
+- View daily calories consumed: calories
+- View daily carbohydrates consumed: carbs
+- View daily proteins consumed: protein
+- View daily fat consumed: fat
+- View daily sugar consumed: sugar
+- View daily fiber consumed: fiber
+- View daily water consumption: viewWater
+- List meal intake: listMeals
+- List drink intake: listDrinks
+- List entire food intake for the day: listEverything
+- Edit an existing meal after inserted: editMeal INDEX s/NEW_SERVING_SIZE
+- Edit an existing drink after inserted: editDrink INDEX s/NEW_SERVING_SIZE
+- Delete certain meal entry: deleteMeal INDEX
+- Delete certain drink entry: deleteDrink INDEX
+- Clear all entries: clear
+- Exit the app: exit
+
+### 1.2 For user to add data
+### 1.2.1 Add a meal eaten: `ate`
+Adds a meal to the list of meals  
+**Format**: ate m/MEAL s/SERVING_SIZE  
+**Sample Input**: ate m/Chicken Rice s/1  
+**Expected Output**: Added 1 serving of Chicken Rice
+
+### 1.2.2 Add a drink: `drink`
+Adds a drink to the list of drinks  
+**Format**: drink d/DRINK s/SERVING_SIZE  
+**Sample Input**: drink d/Lemon Tea s/100  
+**Expected Output**: Added 100ml of Lemon Tea
+
+### 1.2.3 Add water: `water`
+Adds water (in ml) to the daily water intake count  
+**Format**: water s/SERVING_SIZE  
+**Sample Input**: water s/200  
+**Expected Output**: Added 200ml of water
+
+## 1.3 For data retrieval
+### 1.3.1 Find the information about a certain meal: `infoMeal`
+For the specified meal, display its nutritional content to the user  
+**Format**: infoMeal MEAL  
+**Sample Input**: infoMeal chicken rice  
+**Expected Output**:  
+Meal: chicken rice (per serving)  
+Calories: 400  
+Carbs: 50  
+Protein: 30  
+Fat: 20  
+Fiber: 10  
+Sugar: 5
+
+### 1.3.2 Find the information about a certain drink: `infoDrink`
+For the inputed drink, display its nutritional content to the user  
+**Format**: infoDrink DRINK  
+**Sample input**: infoDrink sprite  
+**Expected output**:    
+SPRITE (473 ml)  
+Calories: 194 kcal  
+Carbs: 50g  
+Protein: 0.2g  
+Fat: 0.1g
+
+### 1.3.3 View daily calories consumed: `calories`
+Display current total calorie intake for the day   
+**Format**: calories    
+**Expected output**: Total calories: 100 cal
+
+### 1.3.4 View daily carbohydrates consumed: `carbs`
+Display current total carbohydrates intake for the day  
+**Format**: carbs  
+**Expected output**: Total Carbohydrates: 150 grams
+
+### 1.3.5 View daily proteins consumed: `protein`
+Display current total protein intake for the day  
+**Format**: protein  
+**Expected output**: Total proteins: 100 grams
+
+### 1.3.6 View daily fat consumed: `fat`
+Display current total fat intake for the day  
+**Format**: fat  
+**Expected output**: Total fat: 50 grams
+
+### 1.3.7 View daily sugar consumed: `sugar`
+Display current total sugar intake for the day  
+**Format**: sugar  
+**Expected output**: Total sugar: 20 grams
+
+### 1.3.8 View daily fiber consumed: `fiber`
+Display current total fiber intake (g) for the day  
+**Format**: viewFiber  
+**Expected output**: Total fiber: 20 grams
+
+### 1.3.9 View daily water consumption: `viewWater`
+Display current total water intake (in ml) for the day  
+**Format**: viewWater  
+**Expected output**: Total water intake: 0 ml
+
+## 1.4 For listing arrays
+### 1.4.1 List meal intake: `listMeals`
+List all the meals user inputted today  
+**Format**: listMeals   
+**Expected output**:   
+here's what you have eaten today  
+1.pizza (serving size: 1)
+
+### 1.4.2 List drink intake: `listDrinks`
+List all the drinks user inputted today  
+**Format**: listDrinks  
+**Expected output**:  
+here's what you have drank today  
+1.sprite (serving size: 1)  
+Total water intake: 0 ml
+
+### 1.4.3 List entire food intake for the day: `listEverything`
+List all the drinks and meals inputted today  
+**Format**: listEverything  
+**Expected output**:  
+here's what you have consumed today  
+1.pizza (serving size: 1)  
+2.sprite (serving size: 1)  
+Total water intake: 0 ml
+
+## 1.5 For editing existing data
+### 1.5.1 Edit an existing meal after inserted: `editMeal`
+For a meal that was inputted in the day, edit its serving size  
+**Format**: editMealServingSize INDEX s/NEW_SERVING_SIZE  
+**Sample input**: editMeal 2 s/2  
+**Expected output**: Pizza has been edited to 2 servings
+
+### 1.5.2 Edit an existing drink after inserted: `editDrink`
+For a drink that was inputted in the day, edit its serving size  
+**Format**: editDrinkServingSize INDEX s/NEW_SERVING_SIZE  
+**Sample input**: editDrink 1 s/200  
+**Expected output**: Sprite has been edited to 200 ml
+
+### 1.5.3 Edit water intake after inserted: `editWater`
+Edit serving size of total water intake  
+**Format**: editWaterIntake s/TOTAL_WATER_INTAKE  
+**Sample input**: editWaterIntake 200  
+**Expected output**: Total water has been edited to 200 ml
+
+## 1.6 For deleting data
+### 1.6.1 Delete certain meal entry: `deleteMeal`
+For a meal that was inputted in the day, delete its input based on its index in the meal list
+**Format**: deleteMeal INDEX
+**Sample Input**: deleteMeal 1
+**Expected output**: Removed Chicken Rice From Meals
+
+### 1.6.2 Delete certain drink entry: `deleteDrink`
+For a drink that was inputted in the day, delete its input based on its index in the drink list  
+**Format**: deleteDrink INDEX  
+**Sample input**: deleteDrink 1  
+**Expected output:**  Removed Iced Lemon Tea From Drinks
+
+## 1.7 For clearing data
+### 1.7.1 Clear all entries: `clear`
+Clear all entries in mealList and drinkList  
+**Format**: clear  
+**Expected output**: All entries have been deleted
+
+## 1.8: Exit program
+### 1.8.1 Exit the app: `exit`
+**Format**: exit  
+**Expected output**: Bye. Hope to see you again soon!

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.fitnus.FitNus")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("fitnus")
     archiveClassifier.set("")
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

config/checkstyle/checkstyle.xml

@@ -284,4 +284,4 @@
         <module name="InvalidJavadocPosition"/>
 
     </module>
-</module>
+</module>

config/checkstyle/suppressions.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 
 <!DOCTYPE suppressions PUBLIC
-    "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
-    "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+        "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 
 <suppressions>
   <suppress checks="JavadocType" files=".*Test\.java"/>
   <suppress checks="MissingJavadocMethodCheck" files=".*Test\.java"/>
-</suppressions>
+</suppressions>

db/Drink_db.csv

@@ -0,0 +1,20 @@
+Drink Name,Calories,Carbs,Protein,Fat
+Teh C Bing,231,24,15,1
+Teh,151,29,4,0.8
+Kopi,141,26.7,2.3,2.8
+Milo,124,20,3.4,3.4
+Milo Dinosaur,270,42,7,8
+Sugarcane juice ,192,52.2,0,0
+Bandung,153,32,1.1,2
+Teh Tarik,124,21.22,2.98,3.28
+100 plus,72,18,0,0
+Tiger Beer (100ml),42,3.4,0.4,0
+Kopi O,67,14.9,0.5,0
+Kopi C,117,20,1,3.6
+Iced Lemon Tea,95,20.9,1,0.1
+Honey Lemon Tea,134,36,0.2,0
+Soursop Juice ,117,25,2.8,1.4
+Kalamansi Juice,168,42,0,0
+Chrysanthemun Juice ,12.2,1.54,1.71,0.3
+Guava Juice ,143,38,0,0
+Plum Juice ,57,13.3,0.5,0

db/Meal_db.csv

@@ -0,0 +1,22 @@
+Meal Name,Calories,Carbs,Proteins,Fats,Fiber
+Chicken Rice (382g),607,75,25,23,2
+Char Kway Teow (384g),744,76,23,29.2,7.3
+Laksa,377,71,18,2,4
+Hokkien Prawn Mee,522,69,18,19,4.4
+Kaya Toast ,459,44.4,8,27.2,1.3
+Mee Goreng (309g),500,61,18,20,4.4
+Char Siew Rice (327g),605,91,24,16,5.9
+Nasi lemak (210g),494,80,13,14,6.5
+roti prata ,209,32,5,7,1.7
+Pork Satay with Satay Sauce ,36,0.36,4.99,1.52,0
+Nasi Goreng (1 cup),346,44.95,12.93,12.25,1.4
+Wanton Mee (400g),555,96.79,15.1,14.13,13.8
+Mala ,583,72.35,12.22,30.85,7
+Oyster Omlette ,467,40.07,19.03,24.33,0.6
+Pepper lunch ,500,50,40,11,4.6
+Ban Mian (528g),475,48,22,22,3.2
+Soup Kambeng,203.8,5.6,28.8,6.8,1.1
+Durian (100g),147,27.09,1.47,5.33,3.8
+Ice KaChang (504g),257,58,6,1,2
+Tau Huay (282g),153,32.2,14.1,1.5,1
+Chendol (368g),386,59,6,15,2

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://via.placeholder.com/100.png?text=Photo) |    Edward Humianto    |   [Github](https://github.com/edwardhumi)   | [Portfolio](docs/team/edwardhumi.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Jason Lienardi     | [Github](https://github.com/jasonlienardi)  | [Portfolio](docs/team/johndoe.md)
+-- |      Claribel Ho      |  [Github] (https://github.com/claribelho)   | [Portfolio] (docs/team/claribelho.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Bryan Castorius Halim | [Github](https://github.com/BryanCastorius) | [Portfolio](docs/team/bryancastorius.md)