[CS2103-T13-3] Linky Time

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Related issues
+<!-- Please link to the Github issue(s) this PR resolves (type `#` to autocomplete issue) -->
+
+## Description
+<!-- Describe your changes -->
+<!-- If it affects UI, screenshots are highly recommended -->
+
+## How to test
+<!-- List down the steps to test this, if applicable -->
+
+## Other information
+<!--
+This section is optional, you may include things like:
+- What is left to be done after this
+- Any questions or assistance you may require
+-->

.github/workflows/gradle.yml

@@ -38,7 +38,7 @@ jobs:
       - name: Build and check with Gradle
         run: ./gradlew check coverage
 
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v2
         if: runner.os == 'Linux'
         with:
           file: ${{ github.workspace }}/build/reports/jacoco/coverage/coverage.xml

.gitignore

@@ -20,3 +20,28 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*

README.md

@@ -1,14 +1,19 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# LinkyTime
+
+[![CI Status](https://github.com/AY2122S2-CS2103T-T13-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S2-CS2103T-T13-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2122S2-CS2103T-T13-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2122S2-CS2103T-T13-3/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.
+**LinkyTime** is a cross-platform desktop application designed for NUS Computer Science students to efficiently keep track of their online meetings and classes. The application is optimized for use via the Command Line Interface (CLI).
+
+## Quick Start
+
+* If this is your first time using **LinkyTime**, check out the [_Quick Start_ section of the **User Guide**](https://ay2122s2-cs2103t-t13-3.github.io/tp/UserGuide.html#quick-start).
+* If you are interested in contributing to **LinkyTime**, the [**Developer Guide**](https://ay2122s2-cs2103t-t13-3.github.io/tp/DeveloperGuide.html) is a good place to start.
+* If you would like to learn more about the team behind **LinkyTime**, you may check out [**About Us**](https://ay2122s2-cs2103t-t13-3.github.io/tp/AboutUs.html).
+
+## Acknowledgements
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)

build.gradle

@@ -21,10 +21,15 @@ checkstyle {
 }
 
 test {
+    enableAssertions = true
     useJUnitPlatform()
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -66,7 +71,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'linkytime.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,54 @@ 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`
+## LinkyTime Project team
 
-## Project team
+### Chua Bing Quan
 
-### John Doe
+<img src="images/chuabingquan.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/chuabingquan)]
+[[portfolio](team/chuabingquan.md)]
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Software Design
 
-### Jane Doe
+### Justine Koh Yong Tai
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/justinekoh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/justinekoh)]
+[[portfolio](team/justinekoh.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Software Design, Deadlines and Deliverables
 
-### Johnny Doe
+### Tan Chen Xiang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/xmashedxtomatox.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/xMashedxTomatox)]
+[[portfolio](team/xmashedxtomatox.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Software Design, Deadlines and Deliverables
 
-### Jean Doe
+### Tan Ming Li, Natalie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/natalietanml.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/NatalieTanML)]
+[[portfolio](team/natalietanml.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Code Quality, Deadlines and Deliverables
 
-### James Doe
+### Zhou GuanZong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gnoznaug.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Gnoznaug)]
+[[portfolio](team/gnoznaug.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Deliverables and Deadlines

docs/DevOps.md

@@ -45,7 +45,7 @@ As part of CI, this project uses Codecov to generate coverage reports. When CI r
 1. Sign up with Codecov using your GitHub account [here](https://codecov.io/signup).
 1. Once you are inside Codecov web app, add your org (that contains the fork) to CodeCov.
 1. Wait for the next run of CI in your fork (or push a dummy commit to it to trigger CI) to confirm CI is able to upload generated coverage data to CodeCov. If CodeCov is not set up correctly, the CI run will fail with an error message that mentions CodeCov.
-1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.
+1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/AY2122S2-CS2103T-T13-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2122S2-CS2103T-T13-3/tp) in that page reflects the coverage of your project.
 
 ### Repository-wide checks
 
@@ -74,7 +74,7 @@ Any warnings or errors will be printed out to the console.
 
 Here are the steps to create a new release.
 
-1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
+1. Update the version number in [`MainApp.java`](https://github.com/AY2122S2-CS2103T-T13-3/tp/tree/master/src/main/java/seedu/address/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
 1. Tag the repo with the version number. e.g. `v0.1`
 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.