Merge branch 'master' into branch-Add-Meeting

Author: gloon99

README.md

@@ -2,7 +2,7 @@
 
 ![Ui](docs/images/Ui.png)
 
-* Modduke is a integrated addressbook with scheduler functionalities targeted at NUS Students<br>
+* ModDuke is a integrated addressbook with scheduler functionalities targeted at NUS Students<br>
   Example usages:
   * as a one stop place to keep track of contact details related to NUS's modules e.g. Professors, project group mates
   * as a calendar to keep track of project meetings
@@ -13,7 +13,7 @@
   * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
   * It comes with a **reasonable level of user and developer documentation**.
 * It is named `ModDuke` because it was initially created with similar functionality of the `Duke iP`, while modifying its functionality to suit NUS students.
-* For the detailed documentation of this project, see the **[ModDuke Product Website](https://github.com/AY2021S1-CS2103-F10-2/tp)**.
+* For the detailed documentation of this project, see the **[ModDuke Product Website](https://ay2021s1-cs2103-f10-2.github.io/tp/)**.
 * Our group is extending the functionality of the application to specifically serve NUS students managing many projects from different modules.
 
 * This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

docs/DeveloperGuide.md

@@ -234,29 +234,48 @@ _{Explain here how the data archiving feature will be implemented}_
 
 ### Product scope
 
-**Target user profile**:
+**Target user profile**
 
-* has a need to manage a significant number of contacts
+Anybody → Students → University Students → NUS Students → NUS Students handling multiple projects
+
+* needs to keep track of contacts for various people (Professors, TA, Groupmates)
+* needs to schedule school-related appointments
+* needs to keep track of school-related appointments
 * prefer desktop apps over other types
 * can type fast
 * prefers typing to mouse interactions
 * is reasonably comfortable using CLI apps
 
-**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
+**Value proposition**: 
 
+* seamless contact management which is faster than a typical mouse/GUI driven app
+* convenient scheduling of project meetings and consultations, making planning a work week effortless
+* effective visualisation of schedules and meetings with the application's timeline dashboard
 
 ### User stories
 
 Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
 
-| 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 person               |                                                                        |
-| `* * *`  | user                                       | delete a person                | remove entries that I no longer need                                   |
-| `* * *`  | user                                       | find a person by name          | locate details of persons without having to go through the entire list |
-| `* *`    | user                                       | hide private contact details   | minimize chance of someone else seeing them by accident                |
-| `*`      | user with many persons in the address book | sort persons by name           | locate a person easily                                                 |
+| Priority | As a …​                                    | I want to …​                                                                                                       | So that I can…​                                                                                                 |
+| -------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| `* * *`  | New user                                   | See usage instructions                                                                                                   | Have easy reference when I forget how to use the App                                                               |
+| `* * *`  | NUS Student                                | Add contacts of people around me                                                                                         | Find them quickly and ensure that I don’t lose anyone's contact information                                        |
+| `* * *`  | NUS Student                                | Delete a contact                                                                                                         | Remove old or unwanted contacts                                                                                    |
+| `* * *`  | NUS Student                                | Edit an existing contact                                                                                                 | Change their contact details if it has changed                                                                     |
+| `* * *`  | NUS Student                                | View my entire list of contacts                                                                                          | Select who I want to contact                                                                                       |
+| `* * *`  | NUS Student                                | Clear all contacts                                                                                                       | Reset my contacts                                                                                                  |
+| `* * *`  | NUS Student                                | Label my contacts based on the individual's relationship with me (e.g. TA, Professor, Classmate)                         | Easily identify the contacts relevant to my query                                                                  |
+| `* * *`  | NUS Student                                | Create meetings for events such as projects or assignments                                                               | I can keep track of commitments and upcoming work                                                                  |
+| `* * *`  | NUS Student                                | Add relevant contacts to a meeting                                                                                       | Keep track of who is participating in the meeting and their contact information                                    |
+| `* * *`  | Forgetful NUS Student                      | Assign a meeting a timeslot and date                                                                                     | Track exactly when I am supposed to meet                                                                           |
+| `* * *`  | NUS Student with many meetings             | View all scheduled meetings                                                                                              | Have an overview of all my meetings                                                                                |
+| `* * *`  | NUS Student                                | Create consultations with professors                                                                                     | Track when I have set up meetings with professors and TA’s                                                         |
+| `* * *`  | NUS Student                                | Add contacts to a consultation                                                                                           | Keep track of which professor I am consulting and access his/her contact details easily                            |
+| `* * *`  | NUS Student                                | Assign a consultation a timeslot and date                                                                                | Keep track of when my upcoming consultations are                                                                   |
+| `* * *`  | NUS Student taking many modules            | Create modules                                                                                                           | Add new modules whenever needed                                                                                    |
+| `* * *`  | NUS Student taking many modules            | View relevant groups of contacts by modules                                                                              | I can easily keep track of contact details of individuals in different modules                                     |
+| `* * `   | NUS Student                                | Hide private contact details                                                                                             | Minimize chances of someone else seeing them by accident                                                           |
+| `*    `  | Student who likes to personalise stuff     | Customise the layout of the App                                                                                          | I can organise relevant information in personalised way that I find easy to access                                 |
 
 *{More to be added}*
 
@@ -396,6 +415,119 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
  Use case ends.
 
+**UC07: Clear Contacts**
+
+**MSS**
+
+1.  User makes request to clear all contacts
+2.  Modduke clears all contacts
+
+    Use case ends.
+
+**UC08: Create Meeting**
+
+**MSS**
+
+1.  User makes request to create a meeting
+2.  Modduke accepts request and creates meeting
+
+    Use case ends.
+
+**Extensions**
+
+* 1a. Meeting Name is missing.
+
+  * 1a1. Modduke shows an error message.
+
+    Use case ends
+
+* 1b. Meeting with the same name already exists.
+
+  * 1b1. Modduke shows an error message.
+
+    Use case ends.
+
+**UC09: Set Time/Date for Meeting**
+
+**MSS**
+
+1.  User makes request to edit a specific meeting
+2.  Modduke accepts request and makes changes to meeting
+
+    Use case ends.
+
+**Extensions**
+
+* 1a. Meeting Name is missing.
+
+  * 1a1. Modduke shows an error message.
+
+    Use case ends.
+
+* 1b. Meeting with the same name already exists.
+
+  * 1b1. Modduke shows an error message.
+
+    Use case ends.
+
+**UC10: View all Meeting**
+
+**MSS**
+
+1.  User makes request to show all meetings
+2.  Modduke accepts request and displays all meetings
+
+    Use case ends.
+
+**UC11: Create Consult**
+
+**MSS**
+
+1.  User makes request to create a consult
+2.  Modduke accepts request and creates consult
+
+    Use case ends.
+
+**Extensions**
+
+* 1a. Consult Name is missing.
+
+  * 1a1. Modduke shows an error message.
+
+    Use case ends
+
+* 1b. Consult with the same name already exists.
+
+  * 1b1. Modduke shows an error message.
+
+    Use case ends.
+
+**UC12: Set Time/Date for Consult**
+
+**MSS**
+
+1.  User makes request to edit a specific consult
+2.  Modduke accepts request and makes changes to consult
+
+    Use case ends.
+
+**Extensions**
+
+* 1a. Consult Name is missing.
+
+  * 1a1. Modduke shows an error message.
+
+    Use case ends.
+
+* 1b. Consult with the same name already exists.
+
+  * 1b1. Modduke shows an error message.
+
+    Use case ends.
+
+
+
+*{More to be added}*
 
 ### Non-Functional Requirements
 
@@ -426,7 +558,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 * **Meeting**: A general purpose appointment between students
 
 
-
 --------------------------------------------------------------------------------------------------------------------
 
 ## **Appendix: Instructions for manual testing**

docs/Gemfile

@@ -5,5 +5,7 @@ source "https://rubygems.org"
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 gem 'jekyll'
+gem "jekyll-remote-theme"
+
 gem 'github-pages', group: :jekyll_plugins
 gem 'wdm', '~> 0.1.0' if Gem.win_platform?

docs/Gemfile.lock

@@ -24,10 +24,12 @@ GEM
       http_parser.rb (~> 0.6.0)
     ethon (0.12.0)
       ffi (>= 1.3.0)
+    eventmachine (1.2.7)
     eventmachine (1.2.7-x64-mingw32)
     execjs (2.7.0)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
+    ffi (1.12.2)
     ffi (1.12.2-x64-mingw32)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
@@ -204,6 +206,8 @@ GEM
       jekyll-seo-tag (~> 2.1)
     minitest (5.14.1)
     multipart-post (2.1.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
     nokogiri (1.10.9-x64-mingw32)
       mini_portile2 (~> 2.4.0)
     octokit (4.18.0)
@@ -236,16 +240,17 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    wdm (0.1.1)
     zeitwerk (2.3.0)
 
 PLATFORMS
+  ruby
   x64-mingw32
 
 DEPENDENCIES
   github-pages
   jekyll
-  wdm (~> 0.1.0)
+  jekyll-remote-theme
+  jekyll-theme-midnight
 
 BUNDLED WITH
    2.1.4

docs/UserGuide.md

@@ -59,7 +59,7 @@ Modduke is a **desktop app for managing contacts, optimized for use via a Comman
 </div>
 
 
-### Adding a contact: `contact add`
+### Adding a contact : `contact add`
 
 Adds a contact to Modduke.
 
@@ -93,13 +93,13 @@ Examples:
 *  `contact edit John Doe p/91234567 e/johndoe@example.com` Edits the phone number and email address of John Doe to be `91234567` and `johndoe@example.com` respectively.
 *  `contact edit Roy Chan n/Betsy Crower` Edits the name of Roy Chan to be `Betsy Crower` and clears all existing tags.
 
-### Clear all contacts: `contact clear`
+### Clearing all contacts : `contact clear`
 
-Deletes all existing contacts
+Deletes all existing contacts.
 
 Format: NA
 
-Note: Once cleared, contacts are permanently deleted
+Note: Once cleared, contacts are permanently deleted.
 
 ### Viewing all contacts : `contact list`
 
@@ -109,30 +109,30 @@ Format: `contact list`
 
 ### Creating a Module : `module add`
 
-Creates a Module with a given name and members 
+Creates a Module with a given name and members .
 
-Format: `module add [n/MODULE_NAME] [m/MEMBER_NAMES]`
+Format: `module add n/MODULE_NAME [m/MEMBER_NAMES]…`
 
 Note: A Module can have more than 1 member separated by “,” but can only have one name. Members can be optional.
 
 
-### Add a tag to a user: `label add`
+### Adding a tag to a user : `label add`
 
 Adds a label to a contact
 
-Format: ` label add [c/CONTACT_NAME][t/TAG_NAMES]`
+Format: ` label add c/CONTACT_NAME [t/TAG_NAMES]…`
 
 * Only 1 contact name can be used at a time but multiple tags can be added.
 * Tag names are to be separated by a ",".
 
 Examples:
 * `label add c/Jay t/2103, teamproject`
 
-### Schedule a meeting : `meeting add`
+### Scheduling a meeting: `meeting add`
 
 Schedules a meeting at a given date and time with specified members and a provided meeting name
 
-Format: `meeting add [n/MEETING_NAME] [d/MEETING_DATE]  [t/MEETING_TIME]  [m/MEMBERS]`
+Format: `meeting add n/MEETING_NAME d/MEETING_DATE t/MEETING_TIME m/MEMBERS`
 
 * Creates a meeting with the provided meeting name
 * All the fields must be provided
@@ -142,7 +142,7 @@ Format: `meeting add [n/MEETING_NAME] [d/MEETING_DATE]  [t/MEETING_TIME]  [m/MEM
 Examples:
 *  `meeting add n/CS2103 weekly meeting d/2020-09-20 t/10:00 m/Jay, Roy, Jerryl, Yeeloon, Ekam`
 
-### Edit a meeting : `meeting edit`
+### Editing a meeting: `meeting edit`
 
 Edits a given meeting. Listed below are the meeting details that can be changed:
 1. Name
@@ -160,9 +160,9 @@ Format: `meeting edit MEETING_NAME [n/NEW_NAME] [d/NEW_DATE] [t/NEW_TIME] [cD/CO
 Examples:
 * `meeting edit CS2103 Meeting n/CS2103 Team Project Meeting d/2020:09:27 t/14:00 cD/Ekam, Jay cA/Bob`
 
-### List all Meetings : `meeting list`
+### Listing all Meetings : `meeting list`
 
-Views all of the existing meetings
+Views all of the existing meetings.
 
 Format: NA
 
@@ -172,22 +172,22 @@ View all the existing consults
 
 Format: `list`
 
-### Creating New Consultation: consult add
+### Creating a Consultation : `consult add`
 
 Creates a new consultation with given ConsultName.
 
-Format: `consult add n/CONSULT_NAME [d/CONSULT_DATE] [t/CONSULT_TIME] [m/MEMBERS]`
+Format: `consult add n/CONSULT_NAME d/CONSULT_DATE t/CONSULT_TIME m/MEMBERS`
 
 * CONSULT_NAME is a required field.
 * [d/CONSULT_DATE], [t/CONSULT_TIME], [m/MEMBERS] are optional fields
 * Multiple members can join one consultation. 
 * [d/CONSULT_DATE] is in the YYYY:MM:dd format and [t/CONSULT_TIME] is in the HH:mm format.
 
-### Edit the details of a consult: consult edit
+### Editing a Consultation : `consult edit`
 
 Edits any of the details of a consult
 
-Format: `consult edit CONSULT_NAME [n/NEW_NAME] [d/NEW_DATE] [t/NEW_TIME] [cD/CONTACTS] [cA/CONTACTS]`
+Format: `consult edit CONSULT_NAME [n/NEW_NAME] [d/NEW_DATE] [t/NEW_TIME] [cD/CONTACTS]… [cA/CONTACTS]…`
 
 * [n/NEW_NAME], [d/NEW_DATE], [t/NEW_TIME], [cD/CONTACTS] and [cA/CONTACTS] are all optional fields, 
 * At least one of the optional fields must be provided.

docs/_config.yml

@@ -1,5 +1,10 @@
 title: "Modduke"
-theme: minima
+plugins:
+  - jemoji
+  - jekyll-remote-theme
+remote_theme: jekyll/minima
+minima:
+  skin: solarized
 
 header_pages:
   - UserGuide.md
@@ -11,5 +16,4 @@ markdown: kramdown
 repository: "ay2021s1-cs2103-f10-2/tp"
 github_icon: "images/github-icon.png"
 
-plugins:
-  - jemoji
+

src/main/java/seedu/address/commons/core/Messages.java

@@ -7,6 +7,7 @@ public class Messages {
 
     public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command";
     public static final String MESSAGE_INVALID_COMMAND_FORMAT = "Invalid command format! \n%1$s";
+    public static final String MESSAGE_INVALID_PERSON_DISPLAYED = "The person provided is not in your contacts";
     public static final String MESSAGE_INVALID_PERSON_DISPLAYED_INDEX = "The person index provided is invalid";
     public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";