[CS2103T-W16-4] NusProductivity

.gitignore

@@ -19,3 +19,5 @@ src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
+*.iml
+bin/

README.adoc

@@ -1,11 +1,10 @@
-= Address Book (Level 3)
+= NusProductivity
 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://travis-ci.org/AY1920S2-CS2103T-W16-4/main/[image:https://travis-ci.org/AY1920S2-CS2103T-W16-4/main.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]] ** not yet implemented
+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]] ** not yet implemented
+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]] ** not yet implemented
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -16,14 +15,12 @@ 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 app is intended for NUS students to organise and plan for school related stuff, such as module and module deadlines.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
@@ -32,5 +29,6 @@ endif::[]
 * 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]
+* Code modified from AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
 
 == Licence : link:LICENSE[MIT]

docs/AboutUs.adoc

@@ -4,53 +4,49 @@
 :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.}_ +
+NusProductivity - developed by team W-16-4 +
+_{Work in progress}_ +
 {empty} +
 We are a 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>>]
+=== Zhou Xinwei
+image::zhouxinwei97.jpg[width="150", align="left"]
+{empty} [https://github.com/zhouxinwei97[github]] [<<zhouxinwei97#, portfolio>>]
 
-Role: Project Advisor
+Role: # To be updated
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Ng Xuan Xin
+image::xuanxinng.jpg[width="150", align="left"]
+{empty}[http://github.com/xuanxinng[github]] [<<xuanxinng#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: # To be updated
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Max Pang
+image::mpang45456.jpg[width="150", align="left"]
+{empty}[http://github.com/mpang45456[github]] [<<mpang45456#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Role: # To be updated
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Kang Wang Kai
+image::kangwkk.jpg[width="150", align="left"]
+{empty}[http://github.com/kangwkk[github]] [<<kangwkk#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: # To be updated
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Chen Jiang Wei
+image::watsheldon.jpg[width="150", align="left"]
+{empty}[http://github.com/watsheldon[github]] [<<watsheldon#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Role: # To be updated
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :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/AY1920S2-CS2103T-W16-4/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 `zhou.xinwei [at] u.nus.edu`

docs/DeveloperGuide.adoc

@@ -284,6 +284,9 @@ Refer to the guide <<DevOps#, here>>.
 * can type fast
 * prefers typing over mouse input
 * is reasonably comfortable using CLI apps
+* has a need to manage deadlines and tasks
+* has a need to manage module planning
+* is studying in NUS
 
 *Value proposition*: manage contacts faster than a typical mouse/GUI driven app
 
@@ -292,7 +295,7 @@ Refer to the guide <<DevOps#, here>>.
 
 Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (unlikely to have) - `*`
 
-[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
@@ -303,9 +306,31 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 
 |`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
 
+|`* * *` |user |add deadline |know when to complete tasks in todo list
+
+|`* * *` |user |add module to module plan |see modules I need to take to fulfill degree requirements
+
+|`* * *` |user |show module plan |see list of modules I need to take/have taken
+
 |`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
 
+|`* *` |user |add diary entry |record what I have done for the day
+
+|`* *` |user |delete diary entry |
+
+|`* *` |user |show diary entry list |
+
+|`* *` |user |delete module from module plan |know which modules I have taken
+
+|`* *` |user |fetch module information |
+
+|`* *` |user |know current CAP |
+
+|`* *` |user |sort deadlines |prioritize which tasks to finish first
+
 |`*` |user with many persons in the address book |sort persons by name |locate a person easily
+
+|`*` |user |create group chats |communicate with peers in the same module
 |=======================================================================
 
 _{More to be added}_
@@ -341,6 +366,27 @@ Use case ends.
 +
 Use case resumes at step 2.
 
+[discrete]
+=== Use case: Delete module
+
+*MSS*
+
+1. User requests to show module plan
+2. AddressBook shows module plan
+3. User requests to delete a module taken
+4. AddressBook deletes module
++
+Use case ends.
+
+*Extensions*
+[none]
+* 3a. The given module code is invalid.
++
+[none]
+** 3a1. AddressBook shows an error message.
++
+Use case resumes at step 2.
+
 _{More to be added}_
 
 [appendix]
@@ -349,6 +395,10 @@ _{More to be added}_
 .  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.
 .  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.
+.  Should respond within 2 seconds
+.  Should be easy to use for users who are not IT-savvy
+.  User should be a current student in NUS
+
 
 _{More to be added}_