[CS2113-T11-3] MeetingJio

.gitignore

@@ -11,6 +11,7 @@ src/main/resources/docs/
 # MacOS custom attributes files created by Finder
 .DS_Store
 *.iml
+MeetingJio.txt
 bin/
 
 /text-ui-test/ACTUAL.txt

MeetingJio.txt

@@ -0,0 +1,20 @@
+ibra
+1.[M] TITLE: meeting5		DAY: wednesday		START: 1230		END: 1330		MODE: online
+2.[M] TITLE: meeting5		DAY: thursday		START: 1230		END: 1330		MODE: online
+3.[L] TITLE: cs2113		DAY: friday		START: 1100		END: 1300		MODE: online
+4.[L] TITLE: cs2113		DAY: friday		START: 1430		END: 1530		MODE: online
+5.[L] TITLE: abc		DAY: saturday		START: 1230		END: 1330		MODE: physical
+ym
+1.[M] TITLE: meeting2		DAY: wednesday		START: 1230		END: 1330		MODE: online
+2.[M] TITLE: meeting		DAY: thursday		START: 1230		END: 1330		MODE: online
+3.[L] TITLE: cs2113		DAY: friday		START: 1230		END: 1330		MODE: online
+4.[L] TITLE: cs2113		DAY: friday		START: 1430		END: 1530		MODE: online
+john
+1.[L] TITLE: cs2113		DAY: monday		START: 1200		END: 1300		MODE: online
+2.[L] TITLE: cs2102		DAY: monday		START: 1300		END: 1400		MODE: online
+3.[M] TITLE: meeting2		DAY: wednesday		START: 1230		END: 1330		MODE: online
+4.[M] TITLE: meeting4		DAY: thursday		START: 1230		END: 1330		MODE: online
+peter
+1.[L] TITLE: cs2113		DAY: monday		START: 1200		END: 1300		MODE: online
+2.[M] TITLE: meeting2		DAY: wednesday		START: 1230		END: 1330		MODE: online
+3.[M] TITLE: meeting		DAY: thursday		START: 1230		END: 1330		MODE: online

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.meetingjio.MeetingJio"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "meetingjio"
     archiveClassifier = null
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,10 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+
+| Display                                             |      Name      |               Github Profile                |             Portfolio              |
+|-----------------------------------------------------|:--------------:|:-------------------------------------------:|:----------------------------------:|
+| ![](https://via.placeholder.com/100.png?text=Photo) | Ibrahim Sharul | [Github](https://github.com/ibrahimisramos) | [Portfolio](team/ibrahimsharul.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo) | Ang Yong Ming  |  [Github](https://github.com/angyongming)   |  [Portfolio](team/angyongming.md)  |
+| ![](https://via.placeholder.com/100.png?text=Photo) |  Toh Yan Jie   |   [Github](https://github.com/yanjie1017)   |   [Portfolio](team/tohyanjie.md)   |
+| ![](https://via.placeholder.com/100.png?text=Photo) |     Li Hao     | [Github](https://github.com/lihao-InfoSec)  |     [Portfolio](team/lihao.md)     |
+

docs/DeveloperGuide.md

@@ -4,26 +4,207 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+# 1. Overview
+MeetingJio is a program for **finding potential time slots for team meetings based on everyone’s availability**.
+
+# 2. Design 
+
+## 2.1 Architecture
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+## 2.2 UI Component
+
+## 2.3 Logic Component
+- Parsers
+- Commands
+
+## 2.4 Model Component
+- Timetables
+- Events
+
+## 2.5 Storage Component
+
+# 3. Implementation
+This section describes some noteworthy details on how certain features are implemented.
+
+## 3.1 Add Feature
+The `add` command is a command that allows user to 
+1. add new users to the master timetable.
+2. add new events to the timetables.
+
+The following sequence diagram shows how the `add` operation generally works.
+
+![AddCommandSequenceDiagram](diagrams/AddCommandSequenceDiagram.png)
+
+**_Note:_**
+
+This is a condensed diagram. Several terms in the sequence diagram above have been substituted by a common term.
+
+Common Term | User-specific term | Lesson-specific term | Meeting-specific term      |
+------------|-------------------|----------------------|----------------------------|        
+add | `"add_user ..."`  | `"add_lesson ..."`   | `"add_meeting ..."`     
+AddCommand | `AddUserCommand`  | `AddLessonCommand`   | `AddMeetingCommand`  
+
+
+## 3.1.1 Add User Feature
+`add_user` adds new user and his or her timetable into the master timetable.
+
+The following sequence diagram shows how the `add_user` command works:
+![AddUserCommandSequenceDiagram](diagrams/AddUserCommandSequenceDiagram.png)
+
+
+## 3.1.2 Add Events Feature
+
+`add_lesson` allows users to create a new lesson and add it to their own timetables.
+
+`add_meeting` allows users to create a new meeting and add it to all the existing timetables.
+
+
+The following sequence diagram shows how the `add_lesson` operation works in detail.
+![AddMeetingCommandSequenceDiagram](diagrams/AddLessonCommandSequenceDiagram.png)
+
+Given below is the steps on how the `add_lesson` operation works.
+
+>To be added
+
+The following sequence diagram shows how the `add_meeting` operation works in detail.
+![AddMeetingCommandSequence](diagrams/AddMeetingCommandSequence.png)
+
+Given below is the steps on how the `add_meeting` operation works.
+
+>To be added
+> 
+## 3.2 Listing Events Feature
+The `list` command is a command that the user can input in order to list out the events he has in his timetable.
+
+`list [user]` displays the timetable for the particular user.
+
+`list all` displays the timetable for all users.
+
+In essence, the `list all` command repeatedly calls `list [user]` for all users.
+
+Before the timetable is listed out, it will also be sorted according to day and time for easy reading.
+
+The following sequence diagram shows how the command `` is executed.
+![ListCommandSequenceDiagram](diagrams/ListCommandSequenceDiagram.png)
+
+## 3.3 Finding Common Free Timeslots Feature
+The `free` command is a command that the user can input in order to find timeslots where all users are free.
+
+For greater customisation, `free [duration]` displays all common timeslots which has a duration longer than specified.
+
+The searching algorithm works by marking the busy slots of each timetable first.
+Timings that are not marked 'busy' are then identified as free time slots.
+
+The following sequence diagram shows how the command `free` is executed.
+![FreeCommandSequenceDiagram](diagrams/FreeCommandSequenceDiagram.png)
+
+## 3.4 Delete events `delete`
+Deletes an event from the user's specified timetable
+
+**Format:** ` delete n/NAME i/INDEX`
+
+* Deletes from the timetable of user
+* Deletes the lesson at the specified `INDEX`.
+* The `INDEX` refers to the index number shown in the displayed lesson list.
+
+Example of usage:
+
+`delete n/John i/1`
+
+If the event is a meeting, it will delete this event from all users
+
+The following sequence diagram shows how the `delete` command works:
+![DeleteCommandSequenceDiagram](diagrams/DeleteCommandSequenceDiagram.png)
+
+Before the timetable is listed out, it will also be sorted according to day and time for easy reading.
+
+## 3.4 Data Saving Feature
+
+The save mechanism is facilitated by StorageFile. It creates a text file in the local machine and writes all the elements
+in the MasterTimetable and Timetable to the text file in human-readable format.
+
+Given below is the steps on how the save operation works.
+
+Step 1: When the user exits the application. The StorageFile.saveData will be initialized.
+
+Step 2: It will check for the existence of the data file. If the file is not found, it will create the file.
+Else do nothing.
+
+Step 3: After creating the file, collateAll method will be called to consolidate all elements in the MasterTimetable and Timetable list,
+and write them into the data file.
+
+Step 4: A message will be shown to the user, informing him that the data has been saved successfully. For any exception
+encountered along the way, an error message will be shown.
+
+The following sequence diagram shows how the save operation works:
+![SaveSequenceDiagram](diagrams/SaveSequenceDiagram.png)
+
+## 3.5 Loading Data Feature
+
+The save mechanism is facilitated by StorageFile. It reads the data specified in the local machine and stores all 
+the records back into the MasterTimetable and Timetable list.
+
+Given below is the steps on how the load operation works.
+
+Step 1: When the user starts the application. The StorageFile.LoadData will be initialized.
+
+Step 2: It will check for the existence of the data file. If the file is not found, do nothing.
+Else it will open the file and extract the record line by line.
+
+Step 3: If a record is a lesson type, then it will call ParserLocalData.prepareLoadLesson method.
+Else if the record is a meeting type, then it will add the record into the meetingList.
+
+Step 4: If there is no record left, the program will check if the previous record contain a meeting.
+If yes, it will call for ParserLocalData.prepareLoadMeeting method to add all the meetings into the list.
+
+The following sequence diagram shows how the load operation works:
+![LoadSequenceDiagram](diagrams/LoadSequenceDiagram.png)
+
+## 3.6 Clear events `clear`
+The `clear` command is a command that the user can clear a certain user's timetable or everyone's timetable.
+
+`clear [user]` clears the timetable for the particular user.
+
+`clear all` clearss the timetable for all users.
+
+## 3.7 Edit events feature
+
+The `edit` command is a command that allows users to edit a specified event.
+
+The following sequence diagram shows how the `edit` command works:
+![EditCommandSequenceDiagram](diagrams/EditCommandSequenceDiagram.png)
+
+Given below is the steps on how the `edit` operation works.
+
+>To be added
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+NUS Students who wish to meet as a group (be it for project meetings or to eat together)
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+1. Allow a group of students to quickly identify a common time slot such that all of them are free to meet up
+
+2. If no common time slot, allow students to see who is free at certain time slots
+
+3. The longest time slot with the most number of available students should be suggested first, followed by either shorter time slots or time slots where lesser students are able to make it
+
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+| Version | As a ... | I want to ...                                | So that I can ...                                        |
+|---------|----------|----------------------------------------------|----------------------------------------------------------|
+| v1.0    |new user| see usage instructions                       | refer to them when I forget the command format           |
+| v1.0    |user| add a lesson                                 | view my schedule easily                                  |
+| v1.0    |user| delete a lesson                              | modify my schedule accordingly                           |
+| v1.0    |user| view all the lessons i have in my timetable  | plan my activities accordingly                           |
+| v1.0    |user| add the location paramter to my lesson       | plan my route in advance                                 |
+| v1.0    |user| add a start time and end time to my lessons  | know what time a lesson starts and ends                  |
+| v1.0    |user| clear all the lessons saved in the timetable | reset my timetable without the need to delete one by one |
 
 ## Non-Functional Requirements
 
@@ -36,3 +217,9 @@
 ## Instructions for manual testing
 
 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+
+##Clear Command
+The clear command is one of the commands the user can execute to clear the whole list. 
+
+
+Here is the sequence when the command `clear` is executed.

docs/README.md

@@ -1,6 +1,7 @@
-# Duke
+# MeetingJio
 
-{Give product intro here}
+MeetingJio is a program for **finding potential time slots for team meetings based on everyone’s availability** via a *Command Line Interface (CLI)*. 
+If you can type fast, MeetingJio can get your meeting management tasks done faster than manually eyeballing your timetable.
 
 Useful links:
 * [User Guide](UserGuide.md)