[CS2113T-F12-1] PlanNUS

.gitignore

@@ -15,3 +15,11 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+/text-ui-test/DIFF.TXT
+DIFF.TXT
+PlanNUS.txt
+AddModuleCommand.log
+ModuleLoader.log
+SetTargetCommand.log
+SetTargetCommand.log.1
+ModuleLoader.log.1

README.md

@@ -1,64 +1,46 @@
-# Duke project template
-
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
-
-1. **Configure Intellij for JDK 11**, as described [here](https://se-education.org/guides/tutorials/intellijJdk.html).
-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:
-   ```
-   > Task :compileJava
-   > Task :processResources NO-SOURCE
-   > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
-   ```
-   Type some word and press enter to let the execution proceed to the end.
-
-## Build automation using Gradle
-
-* This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the `build.gradle` file).
-* If you are new to Gradle, refer to the [Gradle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/gradle.html).
-
-## Testing
-
-### I/O redirection tests
-
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
-
-### JUnit tests
-
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
-* If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
-
-## Checkstyle
-
-* A sample CheckStyle rule configuration is provided in this project.
-* If you are new to Checkstyle, refer to the [Checkstyle Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/checkstyle.html).
-
-## CI using GitHub Actions
-
-The project uses [GitHub actions](https://github.com/features/actions) for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.
-
-## Documentation
-
-`/docs` folder contains a skeleton version of the project documentation.
-
-Steps for publishing documentation to the public: 
-1. If you are using this project template for an individual project, go your fork on GitHub.<br>
-   If you are using this project template for a team project, go to the team fork on GitHub.
-1. Click on the `settings` tab.
-1. Scroll down to the `GitHub Pages` section.
-1. Set the `source` as `master branch /docs folder`.
-1. Optionally, use the `choose a theme` button to choose a theme for your documentation.
+# PlanNUS
+
+<table><tr><td><div style="text-align:center">
+    <img src="docs/images/PlanNUSLogo.png" />
+</div></td></tr></table>
+
+#### Foreword
+
+PlanNUS is a greenfield project which aims to solve the gap in undergraduate academic planning in NUS.
+With the Academic Calendar Planner, PlanNUS will be able to assist undergraduate students in forecasting their academic journey for their 4 or 5 years in NUS.
+With the CAP Calculator , PlanNUS will be able to tell you your current CAP and forecast future grades needed to achieve your target CAP.
+
+## Target User Profile
+
+1. All Fresh NUS Undergraduates
+1. NUS Undergraduates who have completed at least 1 semester of study
+
+## Feature List (for V2.0)
+
+* Academic Calendar Planner
+  * Add module
+  * Edit module
+  * Remove module
+  * View module details
+  * Search for module by keyword
+  * Print Calendar
+    * Full Calendar
+    * Semester Calendar
+* CAP Calculator
+  * Get current CAP
+  * Get results need for target CAP
+  * See possible CAP when setting as grade-less
+* General
+  * Saving of Academic Calendar into text file
+  * Loading of Academic Calendar from text file
+
+## Useful Links
+
+* [**About Us**](https://ay2021s1-cs2113t-f12-1.github.io/tp/AboutUs.html)
+* [**Configuration guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/ConfigurationGuide.html)
+* [**Developer guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DeveloperGuide.html)
+* [**DevOps guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DevOpsGuide.html)
+* [**Documentation guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DocumentationGuide.html)
+* [**Logging guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/LoggingGuide.html)
+* [**Testing guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/TestingGuide.html)
+* [**User guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/UserGuide.html)

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'
+    implementation 'com.google.code.gson:gson:2.8.6'  //Google Json serialzation library
+    implementation 'org.apache.commons:commons-lang3:3.11' //Apache commons lang for Class builder
 }
 
 test {
@@ -29,18 +31,27 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.duke.PlanNus"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "PlanNus"
     archiveClassifier = null
 }
 
 checkstyle {
     toolVersion = '8.23'
 }
 
-run{
+run {
     standardInput = System.in
+    enableAssertions = true
+}
+
+jar {
+    manifest {
+        attributes(
+                'Main-Class': 'seedu.duke.PlanNus'
+        )
+    }
 }

docs/AboutUs.md

@@ -1,9 +1,13 @@
 # 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)
+<table><tr><td><div style="text-align:center">
+    <img src="images/PlanNUSLogo.png" />
+</div></td></tr></table>
+
+Display | Name | Github Profile | Portfolio
+---|:---:|:---:|:---:
+![](https://avatars3.githubusercontent.com/u/60382285?s=400) | Jerrold Lam |  [jerroldlam](https://github.com/jerroldlam "Github User Profile") | [Portfolio](team/Lam.md)
+![](https://avatars3.githubusercontent.com/u/56764814?s=100) | Khenus Tan |  [Khenus](https://github.com/Khenus "Github User Profile") | [Portfolio](team/Khenus.md)
+![](https://avatars3.githubusercontent.com/u/60414537?s=100) | Harry Lee |  [harryleecp](https://github.com/harryleecp "Github User Profile") | [Portfolio](team/Harry.md)
+![](https://avatars3.githubusercontent.com/u/57383789?s=100) | Ju Zihao |  [JuZihao](https://github.com/JuZihao "Github User Profile") | [Portfolio](team/Zihao.md)
+![](https://avatars3.githubusercontent.com/u/49282734?s=400) | Vanessa Kang |  [Vanessa-Kang](https://github.com/vanessa-kang "Github User Profile") | [Portfolio](team/Vanessa.md)

docs/ConfigurationGuide.md

@@ -0,0 +1,24 @@
+# Configuration Guide for PlanNUS
+
+<table><tr><td><div style="text-align:center">
+    <img src="images/PlanNUSLogo.png" />
+</div></td></tr></table>
+
+## Table of contents
+
+* Table of contents
+{:toc}
+
+## Configuration Guide
+
+Certain properties of the application can be controlled (e.g user saved modules file location, logging level) through the configuration file (default: `config.json`).
+
+## Useful Links
+
+* [**About Us**](https://ay2021s1-cs2113t-f12-1.github.io/tp/AboutUs.html)
+* [**Developer guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DeveloperGuide.html)
+* [**DevOps guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DevOpsGuide.html)
+* [**Documentation guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DocumentationGuide.html)
+* [**Logging guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/LoggingGuide.html)
+* [**Testing guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/TestingGuide.html)
+* [**User guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/UserGuide.html)

docs/DevOpsGuide.md

@@ -0,0 +1,67 @@
+# DevOps Guide for PlanNUS
+
+<table><tr><td><div style="text-align:center">
+    <img src="images/PlanNUSLogo.png" />
+</div></td></tr></table>
+
+## Table of contents
+
+* Table of contents
+{:toc}
+
+## Build Automation
+
+PlanNUS uses `Gradle` for build automation and dependency management. 
+
+Below shows how `Gradle` is being used in PlanNUS for important project tasks
+
+* **`test`**: Runs all available test
+  * Command: `./gradlew clean test`: Cleans the project before running the test
+  * Command: `./gradlew test`: Runs all the test
+* **`shadowJar`**: ShadowJar plugin is responsible for packaging PlanNUS into a *fat* JAR file, which is located under `build/lib` folder. If applicable, ShadowJar will replace previous versions of `PlanNUS.jar` with the latest version.
+  * Command: `./gradlew shadowJar`
+
+* **`clean`**: Deletes the files created during the previous build (i.e. files and folders that are in the `build` folder)
+  * Command: `./gradlew clean`
+* **`checkstyle`**: Checks for styling compliance across the whole project
+  * Command: `./gradlew checkstyleMain`: Checks for styling compliance in the `main` package of PlanNUS
+  * Command: `./gradlew checkstyleTest`: Checks for styling compliance in the `test` package of PlanNUS
+* **`build`**: Runs all available `tests` and `checkstyle` before packaging PlanNUS with `ShadowJar` if project passed all test cases and style check without issue.
+  * Command: `./gradlew build`
+
+## Continuous Integration (CI)
+
+PlanNUS uses GitHub Actions for continuous integration. The necessary GitHub Actions configuration files exist as `.github/workflows/gradle.yml`. This file does not require further set up.
+
+## I/O Testing
+
+PlanNUS uses automated scripts located in the `./text-ui-test` folder to test for the correct output given a sequence of inputs. 
+
+To test for the input/output of PlanNUS
+
+1. Change needed input in `input.txt` located in `./text-ui-test` folder
+2. Change the expected output in `EXPECTED.TXT` located in `./text-ui-test` folder
+3. Run the scripts for testing
+   * On windows, run `runtest.bat`
+   * On UNIX systems, run `runtest.sh`
+4. The scripts will run and throws a warning message if the actual output differs from the expected output
+5. The actual output will be stored in `ACTUAL.TXT` located in `./text-ui-test` folder
+
+## Making a release
+
+Here are the steps to create a new release.
+
+1. Generate a fat JAR file using Gradle with the command`gradlew build`.
+2. Tag the repo with the version number. e.g. `V2.0`
+3. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.
+
+## Useful Links
+
+* [**About Us**](https://ay2021s1-cs2113t-f12-1.github.io/tp/AboutUs.html)
+* [**Configuration guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/ConfigurationGuide.html)
+* [**Developer guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DeveloperGuide.html)
+* [**Documentation guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/DocumentationGuide.html)
+* [**Logging guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/LoggingGuide.html)
+* [**Testing guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/TestingGuide.html)
+* [**User guide**](https://ay2021s1-cs2113t-f12-1.github.io/tp/UserGuide.html)
+