nus-cs2113-AY2223S2 · bentohset · Mar 28, 2023 · Mar 28, 2023 · Mar 28, 2023 · Mar 28, 2023
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/data/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,10 @@
+{
+    "java.configuration.updateBuildConfiguration": "disabled",
+    "java.debug.settings.onBuildFailureProceed": true,
+    "java.project.referencedLibraries": [
+        {
+            "scope": "java",
+            "path": "src/main/resources"
+        }
+   ]
+}
diff --git a/build.gradle b/build.gradle
@@ -12,6 +12,8 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+    // https://mvnrepository.com/artifact/com.googlecode.json-simple/json-simple
+    implementation group: 'com.googlecode.json-simple', name: 'json-simple', version: '1.1.1'
 }
 
 test {
@@ -28,19 +30,32 @@ test {
     }
 }
 
+sourceSets {
+    main {
+        resources {
+            srcDirs = ['src/main/resources']
+        }
+    }
+}
+
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "seedu.penus.Penus"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "penus"
     archiveClassifier = null
 }
 
 checkstyle {
     toolVersion = '10.2'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
 }
+jar {
+    duplicatesStrategy(DuplicatesStrategy.EXCLUDE)
+}
+
diff --git a/docs/.idea/.gitignore b/docs/.idea/.gitignore
diff --git a/docs/.idea/checkstyle-idea.xml b/docs/.idea/checkstyle-idea.xml
diff --git a/docs/.idea/vcs.xml b/docs/.idea/vcs.xml
diff --git a/docs/AboutUs.md b/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) |    Tay Jiun Yuan    |         [Github](https://github.com/)         | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Chia Yu Xuan     |    [Github](https://github.com/chiayuxuan)    | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lee Jun Hui Ansenn  |      [Github](https://github.com/ansenn)      | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Senthilkumar Sriram | [Github](https://github.com/sriram-senthilkr) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Benjamin Toh     |    [Github](https://github.com/bentohset)     | [Portfolio](docs/team/johndoe.md)
+
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
-# Duke
+# PENUS 👾
 
-{Give product intro here}
+Planning Engineering with NUS (PENUS) is a desktop app that helps engineering students oversee and plan their modules in their university life!
 
 Useful links:
 * [User Guide](UserGuide.md)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -1,42 +1,207 @@
-# User Guide
+# 📜 PENUS User Guide
+
+<pre>
+ ___  _____        ______    ___  ___     ___   _________
+/   \/      \     /      \  /   \/   \   /   \ /         \ 
+|      __    \    |       \/    ||   |  |     ||    _     |
+|     |__|    |   |        |    ||   |  |     ||     \    |
+\            /    |    |   |    ||   |  |     |\      \_ /
+/        ___/___  |    |   |    ||   |  |     | \_      \
+|       | /     \ |    |   |    ||   |  |     |/  \      \
+|_______|/   <> _\|    |   |    ||   \__/     ||   \_     |
+\       /|   \____|    / \      |\            /|          |
+ \__|__/  \______/\___/  \_____/  \__________/  \_________/
+</pre>
 
 ## Introduction
 
-{Give a product intro}
-
-## Quick Start
+Planning Engineering with NUS (PENUS) is a desktop app that helps engineering students oversee and plan their modules in their university life! It is optimised for use via a Command Line Interface (CLI). For students that can type fast, PENUS can help them plan and track their modules for all four years of their time in university more efficiently.
+
+## Table of Contents 📔
+- [Quick Start](#quick-start-⚙️)
+- [Features](#features-👾)
+    + [Initialisation: `init`](#initialisation-init)
+    + [Help: `help`](#help-help)
+    + [Add taken modules: `taken`](#add-taken-modules-taken)
+    + [Plan untaken modules: `plan`](#plan-untaken-modules-plan)
+    + [Remove a module: `remove`](#remove-a-module-remove)
+    + [Mark module as taken: `mark`](#mark-module-as-taken-mark)
+    + [View modules: `list`](#view-modules-list)
+    + [View graduation status: `status`](#view-graduation-status-status)
+    + [View module details: `details`](#view-module-details-details)
+    + [Exit: `exit`](#exit-the-program-exit)
+    + [Saving the data](#saving-the-data)
+    + [Editing the data file](#editing-the-data-file)
+- [FAQ](#faq-💻)
+- [Command Summary](#command-summary-🔑)
+
+## Quick Start ⚙️
 
 {Give steps to get started quickly}
 
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
-
-## Features 
-
-{Give detailed description of each feature}
-
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+2. Download the latest version of PENUS from [here](https://github.com/AY2223S2-CS2113-T11-2/tp/releases/download/v2.0/penus.jar).
+3. Copy the file to the folder you want to use as the home folder for your PENUS.
+4. Open a command terminal, cd into the folder you put the jar file in, and use the `java -jar penus.jar` command to run the application.
+5. Type the command in the Command Line Interface and press Enter to execute it.
+_Some example commands you can try:_
+    - `init`:
+    - `taken CS2113 y/2 s/2 g/A+`: Adds CS2113 to Year 2 Semester 2 with grade A+.
+    - `plan CS2040C y/1 s/2`: Adds CS2040C to Year 1 Semester 2 as untaken
+    - `list`: list all modules in the planner with overall CAP
+    - `remove CS2113`: Deletes the module CS2113
+    - `status`: gets the status of core modules and MCs taken.
+    - `exit`: exits the application.
+6. Refer to features below for details of each command
+
+
+
+## Features 👾
+
+### Initialisation: `init`
+Initialise a user to the planner
+Format: `init n/[NAME] c/[COURSE_INDEX]`
+- COMPULSORY
+- 
+
+Example:
+```
+```
+Output:
+```
+```
+
+### Help: `help`
+Display the help page of the program
+Format: `help`
+Output:
+```
+```
+
+### Add taken modules: `taken`
+Adds a module to the planner as a taken module.
+Format: `taken [MODULE_CODE] y/[YEAR] s/[SEMESTER] g/[GRADE]`
+- `MODULE_CODE` is compulsory
+- 
+
+Example:
+```
+
+```
+Output:
+```
+```
+
+
+### Plan untaken modules: `plan`
+Adds a module to the planner as a planned module
+Format: `plan [MODULE_CODE] y/[YEAR] s/[SEMESTER]`
+- `MODULE_CODE` is compulsory
+- 
+
+Example:
+```
+```
+Output:
+```
+```
+
+
+### Remove a module: `remove`
+Removes a module from the planner
+Format: `remove [MODULE_CODE]`
+- `MODULE_CODE` is compulsory
+- 
+
+Example:
+```
+remove CS2113
+```
+Output:
+```
+```
+
+
+### Mark module as taken: `mark`
+Marks the mod that has been cleared and update its grade.
+Format: `mark [MODULE_CODE] g/[GRADE]`
+- `MODULE_CODE` is compulsory
+- 
+
+Example:
+```
+mark CG2111A g/A+
+```
+Output:
+```
+```
+
+### View modules: `list`
+Displays the list of modules in the planner.
+
+
+### View graduation status: `status`
+Displays the status of Core Modules and MCs Taken.
+Format: `status`
+- TBA
+- 
+
+Example: 
+```
+status
+```
+Output:
+```
+```
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+### View module details: `details`
+Displays the relevant details of a module from NUSMods
+Format: `details [MODULE_CODE]`
+- `MODULE_CODE` is compulsory
+- 
+
+Example:
+```
+details CS2113
+```
+Output:
+```
+```
+
+
+### Exit the program: `exit`
+Exit the application.
+Format : `exit`
+
+### Saving the data
+PENUS's data are saved in the hard disk automatically after exiting the program. 
+There is no need to save manually.
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
 
-Example of usage: 
+### Editing the data file
+PENUS's data are saved as a .txt file in `[JAR file location]/data/penus.txt`. 
+Edits must be made according to the formatting of the data.
 
-`todo n/Write the rest of the User Guide d/next week`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
 
-## FAQ
+## FAQ 💻
 
 **Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file in `/data/penus.txt` that contains the data of your previous PENUS application.
 
-## Command Summary
 
-{Give a 'cheat sheet' of commands here}
+## Command Summary 🔑
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+| Command      | Format                                        |
+|--------------|-----------------------------------------------|
+| **init**     | `init`                                        |
+| **help**     | `help`                                        |
+| **taken**    | `taken MODULE_CODE y/YEAR s/SEMESTER g/GRADE` |
+| **plan**     | `plan MODULE_CODE y/YEAR s/SEMESTER`          |
+| **remove**   | `remove MODULE_CODE`                          |
+| **mark**     | `mark MODULE_CODE`                            |
+| **list**     | `list (FILTER)`                                        |
+| **status**   | `status`                                      |
+| **details**  | `details MODULE_CODE`                         |
+| **exit**     | `exit`                                        |
diff --git a/docs/uml/CAP.png b/docs/uml/CAP.png
diff --git a/docs/uml/diagrams/AddModSequence.png b/docs/uml/diagrams/AddModSequence.png
diff --git a/docs/uml/diagrams/Architecture.png b/docs/uml/diagrams/Architecture.png
diff --git a/docs/uml/diagrams/GradeClass.png b/docs/uml/diagrams/GradeClass.png
diff --git a/docs/uml/diagrams/LogicClass.png b/docs/uml/diagrams/LogicClass.png
diff --git a/docs/uml/diagrams/MarkModSequence.png b/docs/uml/diagrams/MarkModSequence.png
diff --git a/docs/uml/diagrams/ModelClass.png b/docs/uml/diagrams/ModelClass.png
diff --git a/docs/uml/diagrams/RemoveModSequence.png b/docs/uml/diagrams/RemoveModSequence.png
diff --git a/docs/uml/diagrams/SaveFeatureClass.png b/docs/uml/diagrams/SaveFeatureClass.png
diff --git a/docs/uml/diagrams/UiClass.png b/docs/uml/diagrams/UiClass.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,3 +15,5 @@ bin/

		/text-ui-test/ACTUAL.TXT
		text-ui-test/EXPECTED-UNIX.TXT

		/data/