Merge remote-tracking branch 'team-tp/master' into dg-more-usecases

# Conflicts:
#	docs/UserGuide.md

Author: totoyoyo

README.md

@@ -5,4 +5,20 @@
 
 MeetBuddy is a desktop application to help manage your social life.
 
+**MeetBuddy** is a desktop app optimised for people who want to organise their meetings and their contacts.
+They can store both meetings and contacts, view the meetings scheduled for the week, and take note of which contacts
+they are meeting up with. It also allows users to assign notes to their meetings to keep people informed about meeting
+details. Furthermore, it supports automatic syncing of contacts profile photos if they have a Gravatar account. The app is
+targeted towards users with a daily 7am - 4pm schedule, have frequent meetings during this period, and prefer typing.
+
+### Site Map
+
+[User Guide](docs/UserGuide.md)
+
+[Developer Guide](docs/DeveloperGuide.md)
+
+[AboutUs](docs/AboutUs.md)
+
+
+
 ****

docs/AboutUs.md

@@ -30,7 +30,7 @@ We are a team based in the [School of Computing, National University of Singapor
 
 <img src="images/maurice2n97.png" width="200px">
 
-[[homepage](https://github.com/Maurice2n97)]
+
 [[github](https://github.com/Maurice2n97)]
 [[portfolio](team/maurice2n97.md)]
 

docs/DeveloperGuide.md

@@ -310,7 +310,7 @@ Takes up less space in the model.
 a whole column, or search through the slots in the column to find the slot.
 
 
-#### setTimetable
+#### Implementation : `setTimetable`
 
 We store an SimpleObjectProperty of a localDate inside a class called timetablePrefs in the model.
 When we initialize the Ui components, a ReadOnlyObservableValue of this localDate is passed to the TimetableView.
@@ -494,6 +494,11 @@ Users would be better able to manage their social and academic commitments by to
 
   Use case ends.
 
+<<<<<<< HEAD
+**Use case: Viewing meetings in the timetable**
+
+=======
+>>>>>>> 6b3cdedcdc7d066e766ef5f4d6971efdb9916ac1
 
 New features on V1.2
 5.  Assign priorities to contacts
@@ -581,10 +586,11 @@ New features on V1.2
 ## Appendix: Non-Functional Requirements
 
 1.  Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
-2.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
-3.  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.
-4.  The response to any use action should become visible within 2 seconds.
-5.  The source code should be open source.
+2.  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.
+3.  The response to any use action should become visible within 2 seconds.
+4.  The source code should be open source.
+5.  There should not be noticeable lag in the UI when handling up to 100 people.
+
 
 ## Appendix: Glossary
 

docs/UserGuide.md

@@ -36,15 +36,18 @@ their profile pictures.
 
    * **`exit`** : Exits the app.
 
-1. Refer to the [Features](#features) below (after glossary) for details of each command.
+1. Refer to the [Features](#features) below for details of each command.
 
 --------------------------------------------------------------------------------------------------------------------
 ## Glossary 
 
 * **Contact**: The set of all the persons stored in MeetBuddy, which is shown in the left part of the GUI.
 * **Person(s)**: Refers to the persons in the contact.
-* **Person Meeting**: Refers to features/models and other aspects that are 
+* **Person Meeting**: Refers to features/models and other aspects that are |
   related to both persons(contact) and meetings in MeetBuddy.
+* **Person Meeting Connection**: Refers to the associations between people and meeting within 
+MeetBuddy.
+
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -82,6 +85,8 @@ there is no such day corresponding to the given month and year of the date, the
 
 </div>
 
+### Composition of the app
+
 ### Viewing help : `help`
 
 Shows a message explaning how to access the help page.
@@ -105,7 +110,7 @@ MeetBuddy data are saved in the hard disk automatically after any command that c
 
 Person Contact data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Users are not suggested updating data directly by editing that data file.
 Meeting data are saved as a JSON file `[JAR file location]/data/meetingbook.json`. Users are not suggested updating data directly by editing that data file.
-Person Meeting Connection data are saved as a JSON file `[JAR file location]/data/connctions.json`. Users are not suggested updating data directly by editing that data file.
+Person-Meeting Connection data are saved as a JSON file `[JAR file location]/data/connctions.json`. Users are not suggested updating data directly by editing that data file.
 <div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
 If your changes to the data file makes its format invalid, MeetBuddy will discard all data and start with an empty data file at the next run.
 </div>
@@ -336,6 +341,8 @@ Shows a list of all persons and meetings in MeetBuddy.
 
 Format: `list`
 
+## Timetable feature
+=======
 ### Adding persons related for a meeting: `addptm`
 
 Adds persons related to a meeting in MeetBuddy.
@@ -362,7 +369,8 @@ Format: `deletepfm INDEX p/PERSON RELATED INDEX1 [p/PERSON RELATED INDEX2]… 
 Examples:
 * `deletepfm 1 p/1 p/2 p/2` Deletes the person on index 1 and 2 from the contacts related field in meeting 1.
 
-##Timetable feature
+## Timetable feature
+
 
 ### Viewing Timetable: 
  No command is necessary. Just click on the timetable tab to switch view from meeting list to timetable. The timetable
@@ -374,12 +382,24 @@ Examples:
  * The length of the meeting slot is proportional to the timespan of the meeting.
 
  Note that it will correctly update and display all meetings. Meetings that fall outside the range of the timetable 
- will be filtered off. Some things to note:
+ will be filtered off. 
+ ![An Example Timetable](images/exampleTimetable.png)
+ 
 
- * Default when starting the application, the timetable will have the first ( leftmost column ) representing today's date.
+ 
+ Some things to note:
+ 
+ * Default when starting the application, the timetable will have the first ( leftmost column ) 
+ representing today's date.
  * Meetings can overlap across columns.
- * Setting small meeting times around the edge of the timetable will cause display issues, For example, setting a meeting 
- to 6:44-7:01 might cause display issues from the 7 - 7.01 will not display the date or time.
+ * Setting small meeting times around the edge of the timetable will cause display issues, For example, 
+ setting a meeting 
+ to 6:44-7:01 might cause display issues from the 7 - 7.01 will not display the date or time. Also even though 15 minute 
+ meetings are allowed to be scheduled, the words will appear squished on the timetable. It is therefore highly 
+ recommended to set your meeting times to be `AT LEAST 30 MINS` and `AT MOST 24 characters` long.
+
+![An Example of words being squished](images/SquishedTimetable.png)
+ 
  * Note that you can scroll to view more slots.
 
 
@@ -395,6 +415,7 @@ Examples:
 
 Examples:
 * `setTimetable 2021-04-12` Set the time table to Apr 12th, 2021. You can check it by clicking Timetable in the GUI.
+* `setTimetable` Sets the timetable to today's date. You can double check with the calendar.
 
 --------------------------------------------------------------------------------------------------------------------
 

docs/images/ExampleTimetable.png

@@ -3,44 +3,56 @@ layout: page
 title: Maurice's Project Portfolio Page
 ---
 
-## Project: AddressBook Level 3
+## Project: MeetBuddy Application
 
-AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+MeetBuddy is your handy desktop meeting and contacts management app,
+ optimized for NUS students to manage their social connections and daily meetings who prefer to work with a 
+ Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI)! 
+
+I was in charge of Overhauling the GUI and creating functionality for users to view
+their meeting schedules in the form of a timetable. I also made GUI enhancements and managed the 
+storage component.
+ The GUI of MeetBuddy was created with JavaFX and written in Java,
+ and I have contributed  about 4+ kLoC of code across a span of 6 weeks.
 
 Given below are my contributions to the project.
 
-* **New Feature**: Added the ability to undo/redo previous commands.
-  * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
-  * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
-  * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
-  * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
+* **Minor Feature**: Added the ability to sync contacts profile picture from Gravatar account. ([\#53()], Implement Caching improvements [\#184()])
+  * What it does: If a contact has an email aassociated with a Gravatar account, 
+  the application gets and displays the contact's Gravatar profile picture automatically as a profile picture in MeetBuddy upon adding said contact. 
+  * Justification: This feature improves the product by making it easier to remember contacts as long as they have Gravatar accounts.
+  
+* **Major Feature**: Add a timetable component [\#102()] [\#99()] [\#90()]
+     *What it does : with a setTimetable Command allowing users to switch between different 
+starting dates of the timetable via CLI. Meetings are synced to the timetable when added/ edited or deleted.
+    * Justification: This feature improves the product by making it easier to peruse their weekly schedules, 
+or find free times to schedule events.
 
-* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
 
-* **Code contributed**: [RepoSense link]()
+* **Code contributed! Do check out my code!**: [RepoSense link](https://nus-cs2103-ay2021s2.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=&tabOpen=true&tabType=authorship&tabAuthor=Maurice2n97&tabRepo=AY2021S2-CS2103-T16-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false)
 
 * **Project management**:
-  * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
+  * Managed release `v1.3` on GitHub
+  * Managed the storage component to ensure neatness and code quality [\#57()]
+  * Managed the GUI component to ensure neatness and code quality [\#106()]
+  * Managed integration of Team member Yuheng's features with storage. [\#187()]
 
 * **Enhancements to existing features**:
-  * Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
-  * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
+  * Overhauled the existing GUI (Pull requests ) [\#45()][\#97()]
+  * Wrote additional tests for new features to maintain above 90% coverage for storage component.
+  * Implemented deletem command to delete meetings [\#54()]
+  * Implemented APIs within meeting to handle clashing meeting checks, enhanced add meeting command.[\#75()]
+  
 
 * **Documentation**:
   * User Guide:
-    * Added documentation for the features `delete` and `find` [\#72]()
-    * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
+    * Added documentation for the features `Profile Picture` and `setTimetable` [\#113()]
   * Developer Guide:
-    * Added implementation details of the `delete` feature.
+    * Added implementation details of the `setTimetable` feature. [\#203()]
+    * Updated Ui class Diagram [\#203()]
+    * Updated Storage class Diagram.[\#203()]
+    * Added user stories to DG [\#204]()
 
-* **Community**:
-  * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
-  * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
-  * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
-  * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())
 
-* **Tools**:
-  * Integrated a third party library (Natty) to the project ([\#42]())
-  * Integrated a new Github plugin (CircleCI) to the team repo
 
 * _{you can add/remove categories in the list above}_

docs/images/SquishedTimetable.png

@@ -5,7 +5,7 @@ title: "Tutorial: Adding a command"
 
 Let's walk you through the implementation of a new command — `remark`.
 
-This command allows users of the AddressBook application to add optional remarks to people in their address book and edit it if required. The command should have the following format:
+This command allows users of the MeetBuddy application to add optional remarks to person in their address book panel and edit it if required. The command should have the following format:
 
 `remark INDEX r/REMARK` (e.g., `remark 2 r/Likes baseball`)
 

docs/team/maurice2n97.md

@@ -7,7 +7,7 @@ title: "Tutorial: Removing Fields"
 >
 > —  Antoine de Saint-Exupery
 
-When working on AddressBook, you will most likely find that some features and fields that are no longer necessary. In scenarios like this, you can consider refactoring the existing `Person` model to suit your use case.
+When working on MeetBuddy you will most likely find that some features and fields that are no longer necessary. In scenarios like this, you can consider refactoring the existing `Person` model to suit your use case.
 
 In this tutorial, we’ll do exactly just that and remove the `address` field from `Person`.
 

docs/tutorials/AddRemark.md

@@ -64,7 +64,7 @@ public MeetingCard(Meeting meeting, int displayedIndex) {
             meeting.getConnectionToPerson().stream()
                     .sorted(Comparator.comparing(person -> person.getName().fullName))
                     .forEach(person -> personsRelated.getChildren()
-                            .add(new Label("[" + person.getName().fullName + "]")));
+                            .add(new Label("  [" + person.getName().fullName + "]")));
         }
     }