[CS2103T-W15-4] InternEase

.gitignore

@@ -20,3 +20,5 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+resources/view/puml

README.md

@@ -1,14 +1,23 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# InternEase
+
+InternEase is a **powerful and innovative desktop app designed to streamline the internship application process primarily for Computer Science undergraduates**. With its optimized **combination of a Command Line Interface (CLI) and Graphical User Interface (GUI)**, InternEase offers users the best of both worlds - the speed and efficiency of a CLI for those who can type quickly, and the user-friendly experience of a GUI for those who prefer a visual interface. Whether you’re a seasoned CLI user or a first-time applicant new to work environment, InternEase makes it easy to keep track of your progress, deadlines, and follow-up actions, so you can focus on landing your dream internship.
+
+[![CI Status](https://github.com/AY2223S2-CS2103T-W15-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S2-CS2103T-W15-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2223S2-CS2103T-W15-4/tp/branch/master/graph/badge.svg?token=MVV9ABQAS8)](https://codecov.io/gh/AY2223S2-CS2103T-W15-4/tp)
 
 ![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.
+## About the project
+
+* This is **a software engineering project done by Team W15-4 from CS2103T (AY2223S2)**.<br>
+* The aim of this project is to:
+  * help Computer Science students to keep track of their internship applications
+  * provide a flexible and efficient internship application management interface via **both CLI and GUI**
+* It is named `InternEase` because it eases the internship application management process via both well-implemented CLI and GUI to help users focus on their internship preparations.
+* For the detailed documentation of this project, see the **[InternEase Product Website](https://ay2223s2-cs2103t-w15-4.github.io/tp/)**.
+
+## Getting started
+* View our [quick start guide](https://ay2223s2-cs2103t-w15-4.github.io/tp/UserGuide.html#quick-start) now to get started on an easier internship journey immediately.
+
+## Acknowledgements
+* The project is based on an ongoing software project for a desktop application (called _AddressBook-Level3_) used for managing contact details by [SE-EDU initiative](https://se-education.org/addressbook-level3/).

build.gradle

@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true;
+}
+
 checkstyle {
     toolVersion = '10.2'
 }
@@ -41,6 +45,7 @@ task coverage(type: JacocoReport) {
 }
 
 dependencies {
+    implementation 'org.jetbrains:annotations:23.0.0'
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
 
@@ -65,8 +70,12 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+run {
+    enableAssertions = true
+}
+
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'internEase.jar'
 }
 
 defaultTasks 'clean', 'test'

codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+    - "src/main/java/seedu/address/ui"

docs/AboutUs.md

@@ -5,55 +5,61 @@ title: About Us
 
 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`
+You can reach us at the email `internease[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Lee Jia Sheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jiasheng59.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jiasheng59)]
+[[portfolio](team/jiasheng59.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: `Statistics`, `Find` , `Sort` and `Help` feature
 
-### Jane Doe
+### Lai Hui Qi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/laihuiqi.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/laihuiqi)]
+[[portfolio](team/laihuiqi.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: `Clear`, `Clear_by`, `Delete`, `Exit`, `Revert`, `Revert_all` and `Task Package` related features
 
-### Johnny Doe
+### Benjamin Wee 
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/benjamin-wee.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/benjamin-wee)] [[portfolio](team/benjamin-wee.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: `list`, `add_date` and `remind` feature
 
-### Jean Doe
+### Lau Zhan Ming
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zm-l.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/zm-l)]
+[[portfolio](team/zm-l.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: 
+    * Implement feature to manage internship application: `add`, `edit`
+    * GUI for `add`, `edit`, `delete`, `archive`, `unarchive`
 
-### James Doe
+### Lok Jian Ming
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jianminglok.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jianminglok)]
+[[portfolio](team/jianminglok.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities:
+  * Contact management features: `add_contact`, `edit_contact`, `delete_contact`
+  * Document management features: `add_docs`, `edit_docs`, `delete_docs`
+  * Edit internship application status feature: `edit_status`
+  * Archiving features: `archive`, `unarchive`, `list_archived`