[CS2103T-T14-3] InternBuddy

.gitignore

@@ -20,3 +20,6 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# /bin folder
+/bin/

README.md

@@ -1,14 +1,70 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
-
-![Ui](docs/images/Ui.png)
-
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S2-CS2103T-T14-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2223S2-CS2103T-T14-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2223S2-CS2103T-T14-3/tp)<br>
+
+![Logo](docs/images/internbuddy-logo.png)
+## About InternBuddy
+InternBuddy is a desktop application for Computing undergraduates to manage their internship applications.
+It is optimized for typing where it allows you to complete internship management tasks much more efficiently
+via the keyboard as compared to using traditional Graphical User Interface (GUI) applications.
+If you are a fast typist who is seeking a one-stop platform to systematically organise your internship
+applications, then InternBuddy is the perfect buddy to accompany you during your internship hunt.
+
+InternBuddy runs using Java 11, and is available on the Windows, macOS and Linux operating systems.
+
+
+## Core Features
+1. List all internships
+2. Add an internship
+3. Edit an internship
+4. View an internship
+5. Copy an internship to clipboard
+6. Find internships
+7. Get upcoming events and deadlines
+8. Delete internships by indices
+9. Delete internships by fields
+10. Clear all internships
+11. Get help
+12. Exit 
+13. Navigating through past commands
+
+In InternBuddy, internship data is auto-saved whenever changes are made.
+
+## Getting Started
+1. Ensure you have Java 11 or above installed in your computer. Otherwise, you can download it
+   [here](https://www.oracle.com/java/technologies/downloads/#java11).
+2. Download the latest release of InternBuddy [here](https://github.com/AY2223S2-CS2103T-T14-3/tp/releases).
+3. Copy the file `internbuddy.jar` to the folder that you want to use as the home folder for InternBuddy.
+4. Double-click on the file internbuddy.jar to launch InternBuddy. A GUI similar to the diagram below should appear in
+   a few seconds. Note how the app contains some sample data.
+
+   ![Ui](docs/images/Ui.png)
+
+5. You can interact with InternBuddy by typing into the box with the text `Enter command here...`, then pressing `Enter`
+to execute your command. For example, typing `help` and pressing Enter will open the help window.
+6. Enjoy tracking your internships with InternBuddy!
+
+
+## Additional Information
+
+- If you are a user who is interested in learning more about what InternBuddy offers, do visit the
+[InternBuddy User Guide](https://ay2223s2-cs2103t-t14-3.github.io/tp/UserGuide.html).
+
+- Alternatively, if you are a developer who is curious about the implementation of InternBuddy, check
+out the [InternBuddy Developer Guide](https://ay2223s2-cs2103t-t14-3.github.io/tp/DeveloperGuide.html).
+
+
+## Acknowledgements
+
+* InternBuddy is written in **Java 11**.
+* It is adapted from the [AddressBook Level 3](https://github.com/se-edu/addressbook-level3) project created by
+  the [SE-EDU initiative](https://se-education.org).
+* Libraries and frameworks used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson),
+  [JUnit5](https://github.com/junit-team/junit5) and [TestFX](https://github.com/TestFX/TestFX).
+* GUI testing is implemented with references from [AddressBook Level 4](https://github.com/se-edu/addressbook-level4)
+  and [Please Hire Us](https://github.com/AY2223S1-CS2103T-W17-4/tp). We utilised code from these projects to set
+  up GUI testing and added our own test cases to test the UI components that we created.
+* The feature of Navigating Through Past Commands is primarily adapted from  [HackNet](https://github.com/AY2122S2-CS2103T-W13-3/tp),
+  but we added code modifications and test cases.
+* The sections on explaining the formatting standards and GUI interface in the User and Developer Guides are
+  inspired by [Please Hire Us](https://github.com/AY2223S1-CS2103T-W17-4/tp).
+

build.gradle

@@ -1,3 +1,5 @@
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+
 plugins {
     id 'java'
     id 'checkstyle'
@@ -6,7 +8,8 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+
+mainClassName = 'seedu.internship.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -20,6 +23,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -43,6 +50,7 @@ task coverage(type: JacocoReport) {
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
+    String testFxVersion = '4.0.15-alpha'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
@@ -60,13 +68,81 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
-    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    //@@author eugenetangkj-reused
+    //Reused from //Reused from https://github.com/se-edu/addressbook-level4/blob/master/build.gradle where it taught
+    //me how to include the dependencies for TestFx
+    testImplementation group: 'org.testfx', name: 'testfx-core', version: testFxVersion
+    testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-12.0.1+2'
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'internbuddy.jar'
+}
+
+//@@author eugenetangkj-reused
+//Reused from //Reused from https://github.com/se-edu/addressbook-level4/blob/master/build.gradle
+
+task(guiTests)
+task(nonGuiTests)
+
+// Run `test` task if `guiTests` or `nonGuiTests` is specified
+guiTests.dependsOn test
+nonGuiTests.dependsOn test
+
+task(allTests)
+
+// `allTests` implies both `guiTests` and `nonGuiTests`
+allTests.dependsOn guiTests
+allTests.dependsOn nonGuiTests
+
+test {
+    systemProperty 'testfx.setup.timeout', '60000'
+
+    testLogging {
+        events TestLogEvent.FAILED, TestLogEvent.SKIPPED
+
+        // Prints the currently running test's name in the CI's build log,
+        // so that we can check if tests are being silently skipped or
+        // stalling the build.
+        if (System.env.'CI') {
+            events << TestLogEvent.STARTED
+        }
+    }
+
+    jacoco {
+        destinationFile = new File("${buildDir}/jacoco/test.exec")
+    }
+
+    doFirst {
+        boolean runGuiTests = gradle.taskGraph.hasTask(guiTests)
+        boolean runNonGuiTests = gradle.taskGraph.hasTask(nonGuiTests)
+
+        if (!runGuiTests && !runNonGuiTests) {
+            runGuiTests = true
+            runNonGuiTests = true
+        }
+
+        if (runNonGuiTests) {
+            test.include 'seedu/internship/**'
+        }
+
+        if (runGuiTests) {
+            test.include 'systemtests/**'
+            test.include 'seedu/internship/ui/**'
+        }
+
+        if (!runGuiTests) {
+            test.exclude 'seedu/internship/ui/**'
+        }
+    }
+}
+
+tasks.withType(JavaExec) {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -2,58 +2,59 @@
 layout: page
 title: About Us
 ---
-
-We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
+# About InternBuddy
+We are team InternBuddy, and we are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
 You can reach us at the email `seer[at]comp.nus.edu.sg`
 
-## Project team
+## Project Team
 
-### John Doe
+### Christopher Tan Rui Yang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/potty10.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/potty10)]
+[[portfolio](team/potty10.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: Testing
 
-### Jane Doe
+### Eugene Tang KangJie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/eugenetangkj.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/eugenetangkj)]
+[[portfolio](team/eugenetangkj.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: UI, Documentation
 
-### Johnny Doe
+### Koh Kai Xun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kohkaixun.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/kohkaixun)]
+[[portfolio](team/kohkaixun.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Code Quality
 
-### Jean Doe
+### Lim Hai Leong Shawn
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/seadragon2000341.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/seadragon2000341)]
+[[portfolio](team/seadragon2000341.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Scheduling and Tracking, Deliverables and Deadlines
 
-### James Doe
+### Ou Chuhao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/derricksaltfish.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/DerrickSaltFish)]
+[[portfolio](team/derricksaltfish.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Integration