[CS2103T-T10-3] WorkBook

.gitignore

@@ -8,6 +8,10 @@ src/main/resources/docs/
 /out/
 /*.iml
 
+# VSCode files
+/bin/
+/.vscode/
+
 # Storage/log files
 /data/
 /config.json
@@ -20,3 +24,6 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# Ruby config files for local Jekyll server
+docs/.ruby-version

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)
+[![Java CI](https://github.com/AY2223S1-CS2103T-T10-3/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2223S1-CS2103T-T10-3/tp/actions/workflows/gradle.yml)
+[![codecov](https://codecov.io/gh/AY2223S1-CS2103T-T10-3/tp/branch/master/graph/badge.svg?token=K13DUI69HX)](https://codecov.io/gh/AY2223S1-CS2103T-T10-3/tp)
+
+# WorkBook (WB)
 
 ![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.
+* WorkBook (WB) is a desktop app for CS/tech students who are applying for internships to manage their internship applications.
+
+* WorkBook (WB) is optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, WB can get your internship management tasks done faster than traditional GUI apps.
+
+## Usage 
+
+* Manage your internship applications for easier tracking!
+
+
+## Acknowledgements
+Libraries used: [JavaFX](https://openjfx.io), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5). <br>
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). <br>
+User Guide: Table of Contents with bullet points removed is reused from [@ianyong's team in 2020](https://github.com/AY2021S1-CS2103T-W16-3/tp/pull/190/commits/b91ca546a6a41a977a8dbf4d40c969ab07a49ad7).
+Reused [code](https://github.com/AY2223S1-CS2103T-T10-4/tp/commit/118c73f20a9eac789f37778a2f05e225f76a1110) from CS2103T-T10-4 to parse optional arguments.
+
+

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.workbook.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '10.2'
 }
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'workbook.jar'
 }
 
 defaultTasks 'clean', 'test'

config/checkstyle/checkstyle.xml

@@ -10,6 +10,13 @@
 
 <module name="Checker">
 
+  <!-- Required to allow exceptions in code style -->
+  <module name="SuppressWithPlainTextCommentFilter">
+    <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
+    <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
+    <property name="checkFormat" value="$1"/>
+  </module>
+
   <module name="FileTabCharacter">
     <!-- Checks that there are no tab characters in the file. -->
   </module>

docs/AboutUs.md

@@ -9,51 +9,51 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Daryl Chua
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/rylzxc.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/rylzxc)]
+[[portfolio](team/rylzxc.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: Overall project coordination, deliverables and deadlines
 
-### Jane Doe
+### Adee Aryaa
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/adeearyaa.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/adeearyaa)]
+[[portfolio](team/adeearyaa.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Code Quality
+* Responsibilities: Ensures that Code follows a common style and achieves maximum readability
 
-### Johnny Doe
+### Glemen Neo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/glemenneo.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/glemenneo)] [[portfolio](team/glemenneo.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: UI/UX
+* Responsibilities: Designing and implementing UI elements for new features, improving user experience by redesigning existing UI elements.
 
-### Jean Doe
+### Jacob Kwan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jacobkwan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jacobkwan)]
+[[portfolio](team/jacobkwan.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Integration
+* Responsibilities: Versioning of codebase/releases and overall maintenance of the repository.
 
-### James Doe
+### Tien Yu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tienyu2000.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tienyu2000)]
+[[portfolio](team/tienyu2000.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Documentation
+* Responsibilities: JavaDocs to generate API documentation in HTML format