[CS2113-W14-3] Future Academic Planner (FAP)

.gitignore

@@ -15,3 +15,7 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+src/squenceDiag.puml
+src/ModulePUML.puml
+data/CS2113_AY2324S2_FAP_Storage.txt
+text-ui-test/data

META-INF/MANIFEST.MF

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

README.md

@@ -1,64 +1,33 @@
-# Duke project template
+# Future Academic Planner (FAP)
 
-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.
+[![Java CI](https://github.com/AY2324S2-CS2113T-W14-3/tp/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/AY2324S2-CS2113T-W14-3/tp/actions/workflows/gradle.yml)
 
-## Setting up in Intellij
+![Ui](docs/images/Ui.jpg)
 
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
+Future Academic Planner (FAP) is a robust academic management software designed to help streamline the academic journey
+for NUS Computer Engineering (CEG) students. If you can type fast, FAP can get your module planning done faster than
+traditional GUI apps.
 
-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:
-   ```
-   > 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.
+### Useful Links:
+- [User Guide](docs/UserGuide.md)
+- [Developer Guide](docs/DeveloperGuide.md)
+- [About Us](docs/AboutUs.md)
 
-## Build automation using Gradle
+## Acknowledgements
 
-* 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).
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+We extend our gratitude to the SE-EDU team for providing the project template and extensive documentation which were
+invaluable to this project.
 
-## Testing
+### External Resources Utilized:
+- **NUSMods API**: Used for retrieving detailed module information ([NUSMods](https://nusmods.com))
+- **Gson Library**: Employed for JSON deserialization to handle module data effectively
+  ([Gson GitHub](https://github.com/google/gson))
 
-### I/O redirection tests
+We would like to express our special thanks to:
+- **Professor Akshay, Madhanse**, and the rest of the CS2113T teaching team for their guidance and support throughout
+- this project.
+- The **NUSMods team** for maintaining their API which is crucial for accessing up-to-date module information.
+- **Google**, for developing and maintaining Gson which greatly simplified our data handling processes.
 
-* 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.
+This project is part of the CS2113T module offered by the School of Computing at the National University of Singapore.

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.google.code.gson:gson:2.8.8'
 }
 
 test {
@@ -29,11 +30,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.duke.FAP")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("FAP")
     archiveClassifier.set("")
 }
 
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

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                          |
+|------------------------------------------|---------------|--------------------------------------------|------------------------------------|
+| ![Dexter's photo](images/Dexter.jpg)     | Dexter        | [Github](https://github.com/dextboy/)      | [Portfolio](team/dextboy.md)       |
+| ![ShiXiang's photo](images/ShiXiang.jpg) | Foo Shi Xiang | [Github](https://github.com/sxfoo)         | [Portfolio](team/sxfoo.md)         |
+| ![WenWu's photo](images/WenWu.jpg)       | Fung Wen Wu   | [Github](https://github.com/fungg0)        | [Portfolio](team/fungg0.md)        |
+| ![Dave's photo](images/Dave.png)         | Dave Gunawan  | [Github](https://github.com/jensonjenkins) | [Portfolio](team/jensonjenkins.md) |
+| ![Thaw's photo](images/Thaw.jpg)         | Thaw Tun Zan  | [Github](https://github.com/ThawTunZan)    | [Portfolio](team/thawtunzan.md)    |