[CS2103T-T10-2] DukeCooks

README.adoc

@@ -1,36 +1,28 @@
-= Address Book (Level 3)
+= DukeCooks
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
-https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://travis-ci.org/AY1920S1-CS2103T-T10-2/main[image:https://travis-ci.org/AY1920S1-CS2103T-T10-2/main.svg?branch=master[Build Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
 endif::[]
 
-ifndef::env-github[]
-image::images/Ui.png[width="600"]
-endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
+This is a lifestyle application. It's designed for health-conscious individuals with the preference of using *Command Line Interface (CLI)*.
+You'll be able to manage various aspects of your life, such as your diet, health and exercise regime.
+
+DukeCooks in your hands, get your life all planned!
 
 == Site Map
 
+Work in Progress, to be linked.
+
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
-* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
-_Marco Jakob_.
+* Project is inspired by  https://se-education.org[AddressBook-Level3] by SE-EDU initiative.
 * Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
-
-== Licence : link:LICENSE[MIT]

docs/AboutUs.adoc

@@ -4,53 +4,53 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
-We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
+DukeCooks is a lifestyle app developed by our team.
+
+We are a team of students from: http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== Chua Hua Lun
+image::hua-lun.png[width="150", align="left"]
+{empty}[https://github.com/hua-lun[github]] [<<johndoe#, portfolio>>]
 
-Role: Project Advisor
+Role: Scheduling and Tracking +
+Responsibilities: Dashboard (Statistics and Suggestions)
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Lee Wah
+image::bakwxh.png[width="150", align="left"]
+{empty}[http://github.com/bakwxh[github]] [<<johndoe#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Testing +
+Responsibilities: Recipe Book
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Liew Jun Wei
+image::bigjunnn.png[width="150", align="left"]
+{empty}[http://github.com/bigjunnn[github]] [<<johndoe#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: Documentation +
+Responsibilities: Food Diary
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Khairul
+image::khairulazman1997.png[width="150", align="left"]
+{empty}[http://github.com/khairulazman1997[github]] [<<johndoe#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Integration +
+Responsibilities: Exercise Tracker
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Yeo Yuan Xin
+image::yyuanxin.png[width="150", align="left"]
+{empty}[http://github.com/yyuanxin[github]] [<<johndoe#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: UI Design +
+Responsibilities: Health Records
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,15 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
-* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+* *Bug reports, Suggestions:* Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Contributing:* We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
+* *Email us:* You may also reach out to any of us via the following emails:
+** *Yuan Xin:* `[email protected]`
+
+** *Hua Lun:* `[email protected]`
+
+** *Khairul:* `[email protected]`
+
+** *Jun Wei:* `[email protected]`
+
+** *Lee Wah:* `[email protected]`

docs/DeveloperGuide.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Developer Guide
+= DukeCooks v1.1 - Developer Guide
 :site-section: DeveloperGuide
 :toc:
 :toc-title:
@@ -279,13 +279,14 @@ Refer to the guide <<DevOps#, here>>.
 
 *Target user profile*:
 
-* has a need to manage a significant number of contacts
+* health conscious individuals
+* prefers to have a complete health monitoring all in one app
 * prefer desktop apps over other types
 * can type fast
 * prefers typing over mouse input
 * is reasonably comfortable using CLI apps
 
-*Value proposition*: manage contacts faster than a typical mouse/GUI driven app
+*Value proposition*: monitors all aspects of health in one application
 
 [appendix]
 == User Stories
@@ -295,35 +296,36 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 [width="59%",cols="22%,<23%,<25%,<30%",options="header",]
 |=======================================================================
 |Priority |As a ... |I want to ... |So that I can...
-|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
+|`* * *` |Home Cook |store all my recipes |easily list out all the ingredients I have to buy for a weekly meal plan
 
-|`* * *` |user |add a new person |
+|`* * *` |Indecisive person |get food suggestions |save time when deciding what to eat
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* * *` |Health conscious person |track my health progress |manage my diet
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* * *` |Fitness enthusiast |track my exercises |keep a history of my fitness progress
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+|`* * *` |Food Blogger |consolidate my food and exercise plan |share them with other interested individuals
 
-|`*` |user with many persons in the address book |sort persons by name |locate a person easily
+|`* *` |Foodie |find new places to eat |try out new places and share the experience with others
+
+|`*` |Fun Seeker |keep track of my health in a game like way |have fun and be healthy at the same time
 |=======================================================================
 
-_{More to be added}_
 
 [appendix]
 == Use Cases
 
-(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)
+(For all use cases below, the *System* is `DukeCooks` and the *Actor* is the `user`, unless specified otherwise)
 
 [discrete]
-=== Use case: Delete person
+=== Use case: Add recipe
 
 *MSS*
 
-1.  User requests to list persons
-2.  AddressBook shows a list of persons
-3.  User requests to delete a specific person in the list
-4.  AddressBook deletes the person
+1.  User requests to list recipes
+2.  DukeCooks shows a list of recipes
+3.  User requests to add a recipe to the list
+4.  DukeCooks adds the recipe to the list
 +
 Use case ends.
 
@@ -337,17 +339,115 @@ Use case ends.
 * 3a. The given index is invalid.
 +
 [none]
-** 3a1. AddressBook shows an error message.
+** 3a1. DukeCooks shows an error message.
 +
 Use case resumes at step 2.
 
-_{More to be added}_
+[discrete]
+=== Use case: Suggest Food
+
+*MSS*
+
+1.  User requests for a food suggestion
+2.  DukeCooks gives a food recommendation
+3.  User is satisfied with the recommendation
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 3a. User is unsatisfied with the food recommendations.
++
+[none]
+** 3a1. User asks for another suggestion.
++
+Use case resumes at step 2.
+
+[discrete]
+=== Use case: Add Calorie Intake
+
+*MSS*
+
+1.  User requests to add calorie intake for the day
+2.  DukeCooks shows a list of Nutrition (Breakdown)
+3.  User requests to add certain nutrition value fields
+4.  DukeCooks updates Health Records
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 2a. The Nutrition list is empty (User did not give any nutrition inputs).
++
+[none]
+** 2a1. DukeCooks updates calorie count in Health Records (omit nutritional information).
++
+Use case ends.
+
+* 3a. The given index is invalid.
++
+[none]
+** 3a1. DukeCooks shows an error message.
++
+Use case resumes at step 2.
+
+[discrete]
+=== Use case: Create Workout
+
+*MSS*
+
+1.  User requests to list <<exercise>>
+2.  DukeCooks shows a list of <<exercise>>
+3.  User requests to add an exercise into their <<workout>>
+4.  DukeCooks adds the exercise into the <<workout>>
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 2a. The exercise list is empty
++
+[none]
+** 2a1. DukeCooks updates the list with pre-made exercises.
++
+Use case resumes at step 2.
+
+* 3a. The given index is invalid.
++
+[none]
+** 3a1. DukeCooks shows an error message.
++
+Use case resumes at step 2.
+
+[discrete]
+=== Use case: Create a new diary
+
+*MSS*
+
+1.  User requests to create a new diary
+2.  A new diary is created with the specified name
+
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 1a. Diary name already exists.
++
+[none]
+** 1a1. DukeCooks displays an error message.
++
+Use case ends.
 
 [appendix]
 == Non Functional Requirements
 
 .  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
-.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
+.  Should be able to hold up to 1000 recipes without a significant reduction in performance for typical usage.
 .  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
 
 _{More to be added}_
@@ -358,8 +458,11 @@ _{More to be added}_
 [[mainstream-os]] Mainstream OS::
 Windows, Linux, Unix, OS-X
 
-[[private-contact-detail]] Private contact detail::
-A contact detail that is not meant to be shared with others
+[[workout]] Workout::
+A list of <<exercise>> planned to be done in one session.
+
+[[exercise]] Exercise::
+An activity that works a specific or multiple muscles, usually a repetition of an action.
 
 [appendix]
 == Product Survey