[CS2103T-W17-1] InternSHIP

README.md

@@ -1,14 +1,38 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# InternSHIP
+
+[![CI Status](https://github.com/AY2122S1-CS2103T-W17-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S1-CS2103T-W17-1/tp/actions)
+[![codecov](https://codecov.io/gh/AY2122S1-CS2103T-W17-1/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2122S1-CS2103T-W17-1/tp)
+
+<div style="text-align: justify">
+
+<div style="text-align: center">
+
+![Logo](docs/images/logos/InternSHIP.png)
+</div>
+
+InternSHIP is a **desktop app for university students to manage their internship applications.** It 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, InternSHIP can get your internship management tasks done faster than traditional GUI apps.
+
+<div style="text-align: center">
 
 ![Ui](docs/images/Ui.png)
+</div>
+
+## Useful Webpages
+
+* If you are interested in using InternSHIP, head over to the [_Quick Start_ section of the **User Guide**](docs/UserGuide.md#quick-start).
+* If you are interested about developing InternSHIP, the [**Developer Guide**](docs/DeveloperGuide.md) is a good place to start.
+* If you want to know more about the team behind InternSHIP, check out [**About Us**](https://ay2122s1-cs2103t-w17-1.github.io/tp/AboutUs.html).
+
+
+## Acknowledgements
 
-* 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.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* The formatting and content of this project's documentations are referenced from [AY2021S2-CS2103T-T11-2/tp](https://ay2021s2-cs2103t-t11-2.github.io/tp/).
+* The ship in the InternSHIP icon was obtained from [flaticon.com](https://www.flaticon.com/free-icon/ship_4012401?term=ship&page=1&position=66&page=1&position=66&related_id=4012401&origin=search).
+* [Canva](https://www.canva.com) was used to make the InternSHIP icon.
+* Libraries used:
+  - [JavaFX](https://openjfx.io/)
+  - [Jackson](https://github.com/FasterXML/jackson)
+  - [JUnit5](https://github.com/junit-team/junit5)
+  - [TestFX](https://github.com/TestFX/TestFX)
+</div>

build.gradle

@@ -41,6 +41,7 @@ task coverage(type: JacocoReport) {
 }
 
 dependencies {
+    implementation 'org.jetbrains:annotations:20.1.0'
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
 
@@ -65,8 +66,12 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+run {
+    enableAssertions = true
+}
+
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'internSHIP.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,53 @@ 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`
-
 ## Project team
 
-### John Doe
+### Willy Angga Prawira
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/willyamped.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/willyamped)]
+[[portfolio](team/willyamped.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: UI, Logic, Tests, Documentation
 
-### Jane Doe
+### Modi Trushti Sanjaybhai
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tsm1820.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tsm1820)]
+[[portfolio](team/tsm1820.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Logic, Tests, Documentation
 
-### Johnny Doe
+### Hu Tianran
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nature711.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/nature711)] [[portfolio](team/nature711.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI, Logic, Tests, Documentation
 
-### Jean Doe
+### Qu Tianyue
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tianyue58.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tianyue58)]
+[[portfolio](team/tianyue58.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Logic, Tests, Documentation
 
-### James Doe
+### Felicia Ivane Pranoto
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/feliciaivane.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/feliciaivane)]
+[[portfolio](team/feliciaivane.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsiblities: Logic, Tests, Documentation

docs/Configuration.md

@@ -1,6 +1,6 @@
 ---
 layout: page
-title: Configuration guide
+title: Configuration Guide
 ---
 
 Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).

docs/DevOps.md

@@ -1,10 +1,12 @@
 ---
 layout: page
-title: DevOps guide
+title: DevOps Guide
 ---
 
+## Table of Contents
+
 * Table of Contents
-{:toc}
+  {:toc}
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -48,7 +50,7 @@ As part of CI, this project uses Codecov to generate coverage reports. Here are
 
 ### Repository-wide checks
 
-In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.
+In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirement.
 
 These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory: