[CS2113-T17-2] PlanIT

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Duke
+

build.gradle

@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # 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) |        Insaf        | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |     Zhai Yuxin      | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Brandon Owen Sjarif | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Ishita Mandal    | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)

docs/DeveloperGuide.md

@@ -6,17 +6,146 @@
 
 ## Design & implementation
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+Our program is structured as pictured in the following class diagram:
+![ClassDiagram.png](diagrams/ClassDiagram.png)
+
+All the inheritors of Command are features that will be described below.
+
+### Addition feature
+
+The addition mechanism is facilitated by 'Parser', 'Add', 'ModuleList' and 'UI', where a Module object will be created according to the content inputted by the user and stored in the module list.
+
+Below is an example usage scenario and how the addition mechanism behaves at each step:
+
+Step 1: The user launches the application for the first time. A ModuleList object will be initiated with empty content.
+
+Step 2: The user input of "add m/cs2113 s/y2s1 mc/4 g/a" will be taken in for parser and an object of class 'Add' will be returned.
+
+Step 3: The execute method in the Add class that is overrides will be called with parameter of moduleList and module to be added passed. This will add the Module into the module list created in step 1.
+
+The sequence diagram below illustrates this add mechanism:
+
+![AddUML.png](diagrams/AddUML.png)
+
+### Deletion feature
+
+The deletion mechanism is facilitated by 'Parser', 'Add', 'ModuleList' and 'UI', where a Module object will be deleted according to the module code inputted by the user and removed from the module list.
+
+Below is an example usage scenario and how the addition mechanism behaves at each step:
+
+Step 1: Assume that the user has already added a module named CS2113 into the ModuleList using the following command, "add m/cs2113 s/y2s1 mc/4 g/a"
+
+Step 2: The user input of "delete m/cs2113" will be taken in for the parser and an object of class 'Delete' will be returned.
+
+Step 3: The execute method in the Delete class that is overrides will be called with parameter of the modCode and will iterate through moduleList looking for a Module that matches. It will then remove the Module from the moduleList.
+
+The sequence diagram below illustrates this delete mechanism:
+
+![DeleteUML.png](diagrams/DeleteUML.png)
+
+### View feature
+
+The View mechanism is facilitated by 'Parser', 'View', 'ModuleList', and 'UI', where the user enters
+a semester and the total number of mcs taken that semester is calculated and displayed.
+
+Below is an example usage scenario and how the view mechanism behaves at each step.
+
+Step 1: Assume that the user has already added two modules to y2s1:
+The first module is CS2113, a 4 MC module which was added using the following command "add m/cs2113 s/y2s1 mc/4 g/a"
+The second module is CS2030, a 4 MC module which was added using the following command "add m/cs2030 s/y2s1 mc/4 g/a"
+
+Step 2: The user input of "view s/y2s1" will be taken in for the parser and an object of class 'View' will be returned.
+
+Step 3: The execute method of View class that is overrides will be called with parameter of the semester and will iterate through
+the moduleList. If the semester in which a particular module is taken matches the semester given as the argument, then the module will be added to an ArrayList called matchingModules. In the end, the arrayList matchingModules will be returned.
+
+The sequence diagram below illustrates this view mechanism.
+
+![viewUML.png](diagrams/viewUML.png)
+
+### Mcs feature
+
+The mcs mechanism is facilitated by 'Parser', 'Mcs', 'ModuleList', and 'UI', where the user enters
+a semester and the total number of mcs taken that semester is calculated and displayed. 
+
+Below is an example usage scenario and how the mcs mechanism behaves at each step.
+
+Step 1: Assume that the user has already added two modules to y2s1:
+The first module is CS2113, a 4 MC module which was added using the following command "add m/cs2113 s/y2s1 mc/4 g/a"
+The second module is CS2030, a 4 MC module which was added using the following command "add m/cs2030 s/y2s1 mc/4 g/a"
+
+Step 2: The user input of "mcs s/y2s1" will be taken in for the parser and an object of class 'Mcs' will be returned.
+
+Step 3: The execute method of MCs class that is overrides will be called with parameter of the semester and will iterate through 
+the moduleList. If the semester in which a particular module is taken matches the semester given as the argument, then mcsCount variable 
+will be increased by the number of Mcs of the module taken. In the end, mcsCount will be returned.
+
+The sequence diagram below illustrates this mcs mechanism.
+
+![McsUML.png](diagrams/McsUML.png)
+
+
+### Find feature
+
+The find mechanism is facilitated by 'Parser', 'Find', 'ModuleList', and 'UI', where the user enters
+a keyword and the modules containing the keyword in one of its fields will be displayed.
+
+Below is an example usage scenario and how the find mechanism behaves at each step.
+
+Step 1: Assume that the user has already added two modules to y2s1:
+The first module is CS2113, a 4 MC module which was added using the following command "add m/cs2113 s/y2s1 mc/4 g/a"
+The second module is CS2030, a 4 MC module which was added using the following command "add m/cs2030 s/y2s1 mc/4 g/b"
+
+Step 2: The user input of "find a" will be taken in for the parser and an object of class 'Find' will be returned.
+
+Step 3: The execute method of Find class that is overrides will be called with parameter of the keyword inputted and will iterate through
+the moduleList. If the keyword matches a field of a particular module, the module will be added to a separate array list 
+which will then be displayed to the user.
+
+The sequence diagram below illustrates this find mechanism.
+
+![FindUML.png](diagrams/FindUML.png)
+
+
+### Check feature
+
+The help mechanism is facilitated by 'Parser', 'Check' and 'UI', where the user enters the check command and the resulting 
+eligibility status will be displayed.
+
+The sequence diagram below illustrates this help mechanism.
+
+![CheckUML.png](diagrams/CheckUML.png)
+
+### Help feature
+
+The help mechanism is facilitated by 'Parser', 'Help' and 'UI', where the user enters the word 'help' and a help message with 
+the various commands summary will be displayed.
+
+The sequence diagram below illustrates this help mechanism.
+
+![HelpUML.png](diagrams/HelpUML.png)
+
+### Exit feature
+
+The exit mechanism is facilitated by 'Parser', 'Exit' and 'UI'. 
+This allows the program to exit smoothly with an exit message displayed when the user input is 'exit'.
+
+The sequence diagram below illustrates this exit mechanism.
+
+![ExitUML.png](diagrams/ExitUML.png)
+
 
 
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+Our target user profile are NUS students who are still unsure of what module they will be taking and/or are targeting one of the exchange programs that NUS has to offer (NOC/SEP).
+Through our program students will be able to ensure that they are eligible for these programmes and ensure that they make the most out of their studies in NUS.
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+It is often very confusing for students to plan out the full four years of their studies due to the sheer amount of modules they will be taking.
+Students might also have doubts of their eligibility for the exchange programs. Our program allows users to ensure that they will be eligible for these programs when the time comes.
 
 ## User Stories
 
@@ -31,7 +160,7 @@
 
 ## Glossary
 
-* *glossary item* - Definition
+* *Module* - A class that a student takes for their current semester in NUS
 
 ## Instructions for manual testing