[CS2113-W12-4] Fit Track

.gitignore

@@ -15,3 +15,8 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+*.class
+MANIFEST.MF
+/data/
+/text-ui-test/data/

build.gradle

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

docs/AboutUs.md

@@ -1,9 +1,10 @@
 # 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) | Faris Sirraj |      [Github](https://github.com/)       | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Yeon Jeho   |      [Github](https://github.com/)       | [Portfolio](docs/team/johndoe.md)
+<img src="images/joshua.jpg" width = 25% height = 25%> | Joshua Leong | [Github](https://github.com/J0shuaLeong) | [Portfolio](docs/team/joshua.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Ng Lixuan Nixon   |      [Github](https://github.com/)       | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Mark Lin   |      [Github](https://github.com/)       | [Portfolio](docs/team/johndoe.md)
+

docs/DeveloperGuide.md

@@ -4,34 +4,122 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
+Main structure of the code and the parse feature is adapted from [here](https://github.com/se-edu/addressbook-level2).
+
 ## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Main structure
+
+
+### Architecture
+{insert diagram to show architecture of code}
+
+The ***Architecture Diagram*** above shows the high-level overview and design of the FitTrack app. 
+Given below is a quick overview of each component.
+
+<div markdown="span" class="alert alert-primary">
+
+:bulb: **Tip:** The '.puml' files used to create the diagrams in this document can be found in [diagrams](./diagrams) 
+folder. Refer to the [_PlantUML Tutorial_ at se-edu/guides](https://se-education.org/guides/tutorials/plantUml.html) 
+to learn how to create and edit diagrams.
+
+</div>
+
+The **`Main`** class is called [`FitTrack`](../src/main/java/fittrack/FitTrack.java)
+
+The App consists of eight components.
+* [**`UI`**](#ui-component): The UI of the App.
+* [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk.
+* [**`MealList`**](#meal-list-component): Stores all meals.
+* [**`UserProfile`**](#user-profile-component): The class which handles all profile data.
+* [**`WorkoutList`**](#workout-list-component): Stores all workouts.
+* [**`Parser`**](#parser-component): Handles user input.
+* [**`Data`**](#data-component): Holds the data of the app in memory.
+* [**`Command`**](#command-component): The command executor.
+
+### Core sequence
+Core sequence of code is written in [`FitTrack`](../src/main/java/fittrack/FitTrack.java) class.
+
+![Core structure](images/FitTrackOuter.svg "Outer Structure")
+
+![Inner structure](images/FitTrackCore.svg "Core Structure")
 
+### Creating a feedback for an invalid input
+Refer to [`CommandParser`](../src/main/java/fittrack/parser/CommandParser.java),
+[`InvalidCommand`](../src/main/java/fittrack/command/InvalidCommand.java),
+[`HelpCommand`](../src/main/java/fittrack/command/HelpCommand.java)
+classes.
+
+![Sequence of invalid command](images/InvalidCommand.svg "Sequence of invalid command")
+
+Given below is the Sequence Diagram for interactions within the Logic component for the execute("deletemeal 1") call.
+![Deletemeal command sequence](images/DeleteSequence.svg)
+
+### Storage Component
+Storage load and save functions are written in [`Storage`](../src/main/java/fittrack/storage/Storage.java) class.
+
+![Structure of Storage Load](images/StorageLoad.svg)
+The sequence diagram of the code for loading the file contents into each class.
+
+![Structure of Storage Save](images/StorageSave.svg)
+The sequence diagram of the code for saving data into file
+
+The `Storage` component,
+* can save user profile data in text format and load it back
+* can save meals in text format and load it back
+* can save workouts in text format and load it back
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+People who want to be healthy by managing their diet and workout.
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+Fittrack is a health management application which allows users to record their diet and activity, and help them to reach the goal they have set.
+
+Fittrack also allows it's users to calculate their total calories spent in a day and receive suggestions
+on possible changes to their exercise, diet and lifestyle.
+
+Users will also be able to calculate key parameters of their profile like 
+BMI, ideal weight for their height and so on.
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+|Version| As a ... | I want to ...                                               | So that I can ...                                             |
+|--------|----------|-------------------------------------------------------------|---------------------------------------------------------------|
+|v1.0|new user| know how to use the product                                 | use the product                                               |
+|v1.0|new user| add my height and weight                                    | keep track of my height and weight                            |
+|v1.0|new user| add my calorie intake for a meal                            | record my calorie intake                                      |
+|v1.0|new user| add my daily workout                                        | track my calories burnt                                       |
+|v1.0|new user| set my daily calorie surplus limit                          | know whether my calorie surplus has exceeded the limit or not |
+|v1.0|new user| delete my daily workout                                     | track my calorie usage                                        |
+|v1.0|new user| delete my calorie intake for a meal                         | track my calorie intake                                       |
+|v1.0|new user| edit my height and weight information                       | apply my changed height and weight                            |
+|v1.0|new user| view my calorie intake for a meal                           | know my calorie intake                                        |
+|v1.0|new user| view my daily workout                                       | know my previous daily workouts                               |
+|v1.0|new user| view my height, weight, and daily calorie surplus limit     | know my height, weight and calorie surplus limit              |
+|v2.0|user| find a to-do item by name                                   | locate a to-do without having to go through the entire list   |
+|v2.0|user| Calculate my ideal weight for my height                     | maintain my weight in the healthy range                       |
+|v2.0|user| see the total calories I have consumed on a particular date | track my daily calories intake                                |
+|v2.0|user| see the total calories I have burnt on a particular date    | track my daily calories burnt                                 |
+|v2.0|user| find a meal or workout                                      | quickly search my past meals or workouts                      |
+
+
 
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
 
 ## Glossary
 
-* *glossary item* - Definition
+* *BMI* - Body Mass Index (BMI) is a person’s weight in kilograms (or pounds) 
+divided by the square of height in meters (or feet).
+* People can lose or gain weight through a calorie deficit/surplus,
+by providing them with a platform to easily monitor their calories 
+throughout the day, this can make their weight loss/gain journey
+easier.
+
 
 ## Instructions for manual testing