[CS2103T-T10-3] ELISA

README.adoc

@@ -1,11 +1,7 @@
-= Address Book (Level 3)
+= ELISA
 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-3/main[image:https://travis-ci.org/AY1920S1-CS2103T-T10-3/main.svg?branch=master[Build Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,9 +11,11 @@ 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).
+* Extremely Loud and Intelligent Student Assistant (ELISA) is for students who *want to have an intelligent companion that keeps track of tasks and give friendly reminders on when to take breaks*.
+* More importantly, ELISA is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, ELISA can get your tasks done faster than traditional GUI apps.
 * 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.
+* Interested? Jump to the <<Quick Start>> to get started. Enjoy!
 
 == Site Map
 
@@ -29,6 +27,7 @@ endif::[]
 
 == Acknowledgements
 
+* Built on AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
 * 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_.
 * Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]

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.}_ +
+ELISA _(Exceptionally Loud and Intelligent Student Assistant)_ - Was developed by the https://github.com/AY1920S1-CS2103T-T10-3[T10-3] team. +
+ELISA is a student assistant made for college students who need constant reminders to complete their daily tasks. More importantly, ELISA is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). +
 {empty} +
-We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
+We are a student team based in the 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>>]
+=== Bryan Lim
+image::blimyj.png[width="150", align="left"]
+{empty}[http://github.com/blimyj[github]] [<<johndoe#, portfolio>>]
 
-Role: Project Advisor
+Role: Developer +
+Responsibilities: Commons
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Hema
+image::lrchema.png[width="150", align="left"]
+{empty}[http://github.com/lrchema[github]] [<<johndoe#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Developer +
+Responsibilities: Functionality
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Lim Yu Hui
+image::mannggoo.png[width="150", align="left"]
+{empty}[http://github.com/mannggoo[github]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities: Logic
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Low Cheng Yi
+image::Icesiolz.png[width="150", align="left"]
+{empty}[http://github.com/Icesiolz[github]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
-
+Responsibilities: UI
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Ng Siang Hwee
+image::sianghwee.png[width="150", align="left"]
+{empty}[http://github.com/sianghwee[github]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities: Model
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,7 @@
 :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.
+* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S1-CS2103T-T10-3/main/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`
+* *Email us* : You can also reach us at `holmescordelia8 [at] gmail.com`
+

docs/DeveloperGuide.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Developer Guide
+= ELISA - Developer Guide
 :site-section: DeveloperGuide
 :toc:
 :toc-title:
@@ -14,7 +14,7 @@ ifdef::env-github[]
 endif::[]
 :repoURL: https://github.com/se-edu/addressbook-level3/tree/master
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `AY1920S1-CS2103T-T10-3`      Since: `Sep 2019`      Licence: `MIT`
 
 == Setting up
 
@@ -279,13 +279,15 @@ Refer to the guide <<DevOps#, here>>.
 
 *Target user profile*:
 
-* has a need to manage a significant number of contacts
+* has a need to manage a significant number of tasks
+* needs reminders to take breaks or move on to cover all their work
+* prefers to be more organized with their time and tasks
 * 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*: manage time and tasks more efficiently than a typical mouse/GUI driven app
 
 [appendix]
 == User Stories
@@ -295,52 +297,122 @@ 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
+|`* * *` |user |add a new task |
 
-|`* * *` |user |add a new person |
+|`* * *` |user |mark a task as done | keep track of my remaining tasks
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* * *` |user |delete a task |remove tasks that I no longer need
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* * *` |user |find a task by description |find only the tasks that are relevant to me at that point in time
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+|`* *` |busy student |see my reminders as notifications|be reminded of them even in other applications
 
-|`*` |user with many persons in the address book |sort persons by name |locate a person easily
+|`* *` |user with many tasks |sort tasks by priority |identify which tasks require my immediate attention
 |=======================================================================
 
 _{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 `ELISA` and the *Actor* is the `user`, unless specified otherwise)
 
 [discrete]
-=== Use case: Delete person
-
+=== Use Case 001: Marking a task as done
 *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 enters the command to show the task list.
+2. ELISA shows the task list to the user.
+3. User marks the task as done by using the index of the task.
+4. ELISA updates the task list.
+5. ELISA shows the updated task list to the user.
 +
 Use case ends.
 
 *Extensions*
 
 [none]
-* 2a. The list is empty.
+* 2a. The task list is empty.
 +
 Use case ends.
 
 * 3a. The given index is invalid.
 +
-[none]
-** 3a1. AddressBook shows an error message.
+** 3a1. ELISA shows an error message.
++
+Use case resumes at step 2.
+
+[discrete]
+=== Use Case 002: Adding a task
+*MSS*
+
+1. User creates a new task with a description.
+2. ELISA informs the user that the task has been added.
++
+Use case ends.
+
+*Extensions*
+
+* 1a. User can add deadline.
++
+** 1a1. ELISA informs the user that a deadline has been added to that task.
++
+Use case ends
+
+* 1b. User can add a reminder date.
++
+** 1b1. ELISA informs the user that a reminder has been added to that task.
++
+Use case ends
+
+* 1c. User enters an empty description.
++
+** 1c1. ELISA informs the user that the description cannot be empty.
++
+** 1c2. User enters a non-empty description
++
+Use case resumes at step 2
+
+* a. At any time, User can view the task from the task list or the calendar view.
+* b. At any time, User can add a deadline to the task
+* c. At any time, User can add a reminder to the task
+
+[discrete]
+=== Use Case 003: Deleting a task
+
+*MSS*
+
+1. User enters the command to show the task list.
+2. ELISA shows the task list.
+3. User request to delete a task based on its index.
+4. ELISA deletes the task from the task list.
+5. ELISA shows the updated task list.
+
++
+Use case ends.
+
+*Extensions*
+
+* 2a. The task list is empty.
++
+Use case ends.
+
+* 3a. The given index is invalid.
++
+** 3a1. ELISA shows an error message.
 +
 Use case resumes at step 2.
 
+[discrete]
+=== Use Case 004: Find upcoming reminders.
+
+*MSS*
+
+1. User enters the command to show the reminder list.
+2. ELISA shows the reminder list.
+3. User enters command to sort reminders by date and time.
+4. ELISA shows the updated list of reminders sorted by date and time.
+
 _{More to be added}_
 
 [appendix]