nus-cs2113-AY2324S1 · SebasFok · Nov 9, 2023 · Nov 9, 2023 · Nov 9, 2023 · Nov 9, 2023
diff --git a/.gitignore b/.gitignore
@@ -9,9 +9,16 @@
 src/main/resources/docs/
 
 # MacOS custom attributes files created by Finder
+/htmlReport/
 .DS_Store
 *.iml
 bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+# data files
+/data
+/data/modulesMajor.txt
+/data/modulesTaken.txt
+/META-INF/MANIFEST.MF
diff --git a/META-INF/MANIFEST.MF b/META-INF/MANIFEST.MF
@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Duke
+
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 
 1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
 1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below: i love 2113 
    ```
    > Task :compileJava
    > Task :processResources NO-SOURCE

diff --git a/build.gradle b/build.gradle
@@ -12,6 +12,7 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
+    implementation 'com.googlecode.json-simple:json-simple:1.1.1'
 }
 
 test {
@@ -41,6 +42,7 @@ checkstyle {
     toolVersion = '10.2'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -1,9 +1,9 @@
 # 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                     |
+|--------------------------------|:-----------------------:|:-----------------------------------------:|:-------------------------------------------------:|
+| ![](photos/disney_selfie.png)  | Sebastian Fok Shin Hung |  [Github](https://github.com/SebasFok/)   |         [Portfolio](team/sebastianfok.md)         |
+| ![](photos/j.png)              |    Liow Enqi Janelle    | [Github](https://github.com/janelleenqi/) |       [Portfolio](team/liowenqijanelle.md)        |
+| ![](photos/rohit_pic.png)      |         Rohit R         |  [Github](https://github.com/rohitcube)   |           [Portfolio](team/johndoe.md)            |
+| ![](photos/ryanPic.JPG)        |        Ryan Loh         |  [Github](https://github.com/ryanlohyr)   | [Portfolio](https://ryanlohyr.github.io/ryanloh/) |
+| ![](photos/isaiah_profile.png) |      Isaiah Cerven      |  [Github](https://github.com/CerIsaiah/)  |            [Portfolio](team/isaiah.md)            |
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -4,9 +4,101 @@
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+## Design & implementation, Architecture
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+## Features
+- Pace
+- Left
+- Major
+
+# Implementation
+
+## [Proposed] Pacing and MC Calculation
+
+The proposed "Pacing and MC Calculation" mechanism is implemented to help users track their academic progress and remaining Modular Credits (MCs) required for graduation. This feature is facilitated by the PacingManager, which stores user data and provides functions for calculating the recommended pacing and remaining MCs. The following operations are available:
+
+- PacingManager#calculateRemainingMCs() — Calculates the remaining MCs required for graduation.
+- PacingManager#calculateRecommendedPace() — Recommends the pacing for upcoming semesters.
+
+These operations are exposed in the Pacing interface as Pacing#calculateRemainingMCs() and Pacing#calculateRecommendedPace() respectively.
+
+### Usage Examples
+
+Here are a few examples of how the "Pacing and MC Calculation" feature behaves:
+
+#### Example 1: Calculate Remaining MCs
+
+Command: `pace Y2/S1` (assuming that the user has completed 60 MCs from Y1S1 to Y2S1)
+
+Response:
+`You currently have 100 MCs left until graduation.`
+
+#### Example 2: Calculate Remaining MCs (No Semester Specified)
+
+Command: `pace`
+
+Response:
+`You currently have 100 MCs left until graduation.`
+
+## [Proposed] List Modules Left Feature
+
+The proposed left mechanism is implemented to help users keep tracks of modules left for their major. It is facilitated by `modulesLeft`, `modulesMajor` and `modulesTaken`. Additionally, it implements the following operations:
+
+- `modulesLeft#getDifference(modulesMajor, modulesTaken)` – Keeps the list of modules in `modulesMajor` but not in `modulesTaken` in `modulesLeft`.
+- `modulesLeft#getMainModuleList()` – Returns the list of modules in `modulesLeft`.
+
+This operation is exposed in the `ModulePlannerController` interface as `ModulePlannerController#listModulesLeft()`.
+
+### Usage Examples
+
+Here are a few examples of how the List Modules Left Feature behaves:
+
+#### Example 1: 
+`modulesMajor#getMainModuleList()` gives modules `CS1231S CS2030S CS2040S CS2100 CS2101 CS2106 CS2109S CS3230`.
+`modulesTaken#getMainModuleList()` gives modules `CS1231S MA1511`
+
+Command: `left`
+
+Response:
+`CS2030S CS2040S CS2100 CS2101 CS2106 CS2109S CS3230`
+
+## [Proposed] Input Major Feature
+
+The proposed input major feature is facilitated by `Student`. It tries to store the major specified in userInput txt 
+file such that it can be used across sessions. It will print different responses based on whether the storing of the 
+Major was successful. Additionally, it implements the following operation:
+
+- `Student#setMajor(Major major)` – Saves the selected major in its memory.
+
+This operation is exposed in the `Student` interface as `Student#updateMajor(String userInput)`.
+
+### Usage Examples
+
+Here are a few examples of how the Input Major Feature behaves:
+
+#### Example 1:
+If "CS" is a valid major: `Student#updateMajor("major CS")` calls `Student#setMajor("CS")`, which sets the Major in the 
+student object as `CS` and returns a string `newMajor`
+
+Command: `major CS`
+
+Response: `Major CS selected!`
+
+#### Example 2:
+If "abc" is an invalid major: `Student#updateMajor("major abc")` calls `Student#setMajor("abc")`, which generates an
+IllegalArgumentException, which is caught and returns a string `invalidMajor`
+
+Command: `major abc`
+
+Response: `Please select a major from this list: [list of currently available Majors]`
+
+#### Example 3:
+If no major was specified: `Student#updateMajor("major")` returns a string `currentMajor`
+
+Command: `major`
+
+Response: `Current major is [current major in student object].`
 
 
 ## Product scope

diff --git a/docs/photos/disney_selfie.png b/docs/photos/disney_selfie.png
diff --git a/docs/photos/isaiah_profile.png b/docs/photos/isaiah_profile.png
diff --git a/docs/photos/j.png b/docs/photos/j.png
diff --git a/docs/photos/rohit_pic.png b/docs/photos/rohit_pic.png
diff --git a/docs/photos/ryanPic.JPG b/docs/photos/ryanPic.JPG
diff --git a/docs/team/isaiah.md b/docs/team/isaiah.md
@@ -0,0 +1,6 @@
+# Isaiah - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions
diff --git a/docs/team/liowenqijanelle.md b/docs/team/liowenqijanelle.md
@@ -0,0 +1,6 @@
+# Liow Enqi Janelle - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions
diff --git a/docs/team/sebastianfok.md b/docs/team/sebastianfok.md
@@ -0,0 +1,6 @@
+# Sebastian Fok - Project Portfolio Page
+
+## Overview
+
+
+### Summary of Contributions
diff --git a/src/main/java/seedu/duke/Duke.java b/src/main/java/seedu/duke/Duke.java
@@ -1,21 +1,13 @@
 package seedu.duke;
-
-import java.util.Scanner;
-
+import seedu.duke.controllers.ModulePlannerController;
 public class Duke {
     /**
      * Main entry-point for the java.duke.Duke application.
      */
+    //main should have basically no code except start
     public static void main(String[] args) {
-        String logo = " ____        _        \n"
-                + "|  _ \\ _   _| | _____ \n"
-                + "| | | | | | | |/ / _ \\\n"
-                + "| |_| | |_| |   <  __/\n"
-                + "|____/ \\__,_|_|\\_\\___|\n";
-        System.out.println("Hello from\n" + logo);
-        System.out.println("What is your name?");
-
-        Scanner in = new Scanner(System.in);
-        System.out.println("Hello " + in.nextLine());
+        ModulePlannerController controller = new ModulePlannerController();
+        controller.start();
     }
+
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Manifest-Version: 1.0
		Main-Class: seedu.duke.Duke