[CS2113T-F12-3] Teaching Assistant's Assistant

.gitignore

@@ -13,5 +13,12 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+text-ui-test/ACTUAL.TXT
+.classpath
+.project
+data/
+text-ui-test/data/
+taa.log*
+src/main/java/META-INF/MANIFEST.MF
+.settings/

README.md

@@ -1,29 +1,35 @@
-# Duke project template
+# Teaching Assistant's Assistant (TAA)
 
-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.
+Teaching Assistant's Assistant (TAA) is a Command Line Interface (CLI) application for keeping track of classes and students.
+If you can type fast, TAA can help keep track of your classes and students faster than traditional Graphical User Interface (GUI) apps.
 
 ## Setting up in Intellij
 
-Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
+Prerequisites: `JDK 11` (use the exact version), update Intellij to the most recent version.
 
-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. **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.
    * In the same dialog, you _may_ have to set the Project language level field to the SDK default option.
 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/taa/Taa.java` file, right-click it, and choose `Run Taa.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
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
+   > Task :Taa.main()
+   ------------------------------------------------------------
+   Welcome to
 
-   What is your name?
+   .___________.    ___           ___
+   |           |   /   \         /   \
+   `---|  |----`  /  ^  \       /  ^  \
+       |  |      /  /_\  \     /  /_\  \
+       |  |     /  _____  \   /  _____  \
+       |__|    /__/     \__\ /__/     \__\
+
+   What can I do for you?
+   Enter "help" to view the list of commands
+   ------------------------------------------------------------
    ```
    Type some word and press enter to let the execution proceed to the end.
 
@@ -40,7 +46,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 
 ### JUnit tests
 
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
+* A skeleton JUnit test (`src/test/java/taa/TaaTest.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

build.gradle

@@ -10,6 +10,7 @@ repositories {
 }
 
 dependencies {
+    implementation 'com.google.code.gson:gson:2.8.8'
     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'
 }
@@ -29,11 +30,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "taa.Taa"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "taa"
     archiveClassifier = null
 }
 
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -2,8 +2,8 @@
 
 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)
+![](https://via.placeholder.com/100.png?text=Photo) | Zhen Hong | [hozhenhong99](https://github.com/hozhenhong99) | [Portfolio](team/hozhenhong99.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Dak Nam | [daknam2001](https://github.com/daknam2001) | [Portfolio](team/daknam.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Jon Lim | [jon-the-melon](https://github.com/jon-the-melon) | [Portfolio](team/jon-the-melon.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Rachel | [rachelkeh](https://github.com/rachelkeh) | [Portfolio](team/rachel.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Leyond | [leyondlee](https://github.com/leyondlee) | [Portfolio](team/leyondlee.md)