[CS2113-T11-2] peNUS

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/data/

.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"
+        }
+   ]
+}

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,31 @@ 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)
+}

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)
+

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)

docs/UserGuide.md

@@ -1,42 +1,239 @@
-# User Guide
+# 📜 PENUS User Guide
+
+<pre>
+ ___  _____        ______    ___  ___     ___   _________
+/   \/      \     /      \  /   \/   \   /   \ /         \ 
+|      __    \    |       \/    ||   |  |     ||    _     |
+|     |__|    |   |        |    ||   |  |     ||     \    |
+\            /    |    |   |    ||   |  |     |\      \_ /
+/        ___/___  |    |   |    ||   |  |     | \_      \
+|       | /     \ |    |   |    ||   |  |     |/  \      \
+|_______|/   <> _\|    |   |    ||   \__/     ||   \_     |
+\       /|   \____|    /\       |\            /|          |
+ \__|__/  \______/\___/  \_____/  \__________/  \_________/
+</pre>
 
 ## Introduction
 
-{Give a product intro}
 
-## Quick Start
+**Planning Engineering with NUS (PENUS)** is a desktop app for managing and planning your modules in your university life!
+Users are able to add modules that they have taken, plan for future modules and access useful features such as checking their graduation criteria and calculating their CAP. By using NUSmods API, users can retrieve important module details with a stroke of the keyboard.
+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).
+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`
+On startup, there will be a prompt for first time users to type `init` to start the initialisation process. 
+<br>
+<br>
+Format:`init n/[Name] c/[COURSE NUMBER]` 
+<br>
+<br>
+
+| Course Number | Course                              |
+|---------------|-------------------------------------|
+| 1             | Biomedical Engineering              |
+| 2             | Chemical Engineering                |
+| 3             | Civil Engineering                   |
+| 4             | Computer Engineering                |
+| 5             | Electrical Engineering              |
+| 6             | Environmental Engineering           |
+| 7             | Industrial and Systems Engineering  |
+| 8             | Mechanical Engineering              |
+
+Example:
+- `init n/John Doe c/1` Initiates a user with the name `John` and course `Biomedical Engineering`.
+
+<br>
+
+### Help: `help`
+Shows a message with the format and functionality of all features. 
+<br>
+<br>
+Format:`help`
+
+<br>
+
+### Add taken modules: `taken`
+Adds a module to the planner as a taken module.
+<br>
+<br>
+Format:`taken [MODCODE] y/[YEAR] s/[SEMESTER] g/[GRADE]`
+<br>
+<br>
+Example:
+- `taken CG1111A y/1 s/1 g/A+` means that you have `taken` and cleared the `CG1111A` module in `Year 1` `Semester 1`, and got an `A+` grade for it
+
+
+<br>
+
+### Plan untaken modules: `plan`
+Adds a module to the planner as an untaken module.
+<br>
+<br>
+Format:`plan [MODULE] y/[YEAR] s/[SEMESTER]`
+<br>
+<br>
+Example:
+- `plan CG2111A y/1 s/2` means that you `plan` on taking `CG2111A` in `Year 1` `Semester 2`.
+
+<br>
+
+### Remove a module: `remove`
+
+Removes a mod from the planner.
+<br>
+<br>
+Format:`remove [MODULECODE]`
+<br>
+<br>
+Example:
+-   `remove CS2113`
+
+<br>
+
+### Mark module as taken: `mark`
+Marks the mod that has been cleared and upgrade its grade.
+<br>
+<br>
+Format:`[MODULE CODE] g/[GRADE]`
+<br>
+<br>
+Example:
+- `mark CG2111A g/A+`
+
+<br>
+
+### View modules: `list`
+Displays a list of all modules taken or planned.
+
+
+Format:`list [FILTER]`
+
+
+| Filter                | Action                                 | Example         |
+|-----------------------|----------------------------------------|-----------------|
+| [empty]               | Lists all modules in the planner       | `list`          |
+| y/[YEAR]              | Lists modules in the specific year     | `list y/1`      |
+| y/[YEAR] s/[SEMESTER] | Lists modules in the specific semester | `list y/1 s/1`  |
+
+Example: 
+- `list` Display all modules taken.
+<br>
+  ![list example](./ugmedia/list1.png)
+- `list y/2` Displays modules taken in Year 2.
+
+  ![list example](./ugmedia/list2.png)
+- `list y/2 s/1` Displays modules taken in Year 2 Semester 1.
+
+<br>
+
+### View graduation status: `status`
+Displays the status of core modules* and MCs taken. 
+<br>
+<font size ="1">**Core modules are based on AY21/22*</font>
+<br>
+<br>
+Format:`status`
+<br>
+<br>
+Example: `status` *(course: Computer Engineering)*
+![details example](./ugmedia/status1.png)
 
-## Features 
+<br>
+
+### View module details: `details`
+Display the module title, description, pre-requisites, MCs and SU option. 
+<br>
+<br>
+Format: `details [MODULECODE]`
+<br>
+<br>
+Example:
+- `details CS1010`
+![details example](./ugmedia/details1.png)
+
+<br>
+
+### Exit the program: `exit`
+Exits the program.
+<br>
+<br>
+Format: `exit`
 
-{Give detailed description of each feature}
+<br>
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+### Saving the data
+PENUS's data are saved in the hard disk automatically after exiting the program. 
+There is no need to save manually.
+
+<br>
+
+### 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.
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+<br>
 
-Example of usage: 
-
-`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
+<br>
 
-{Give a 'cheat sheet' of commands here}
+## Command Summary 🔑
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+| Command      | Format                                        |
+|--------------|-----------------------------------------------|
+| **init**     | `init n/NAME c/COURSE NUMBER`                 |
+| **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`                                        |