Create Yi Jing's PPP and stuff

README.adoc

@@ -1,11 +1,11 @@
-= Address Book (Level 3)
-ifdef::env-github,env-browser[:relfileprefix: docs/]
+= TA-Tracker
 
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
+ifdef::env-github,env-browser[:relfileprefix: docs/]
 
+https://travis-ci.org/AY1920S2-CS2103T-W17-4/main[image:https://travis-ci.org/AY1920S2-CS2103T-W17-4/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/PotatoCombat/main[image:https://ci.appveyor.com/api/projects/status/hj9hoqnof01ge3pp/branch/master?svg=true[Build status]]
+https://coveralls.io/github/AY1920S2-CS2103T-W17-4/main?branch=master[image:https://coveralls.io/repos/github/AY1920S2-CS2103T-W17-4/main/badge.svg?branch=master[Coverage Status]]
+image:https://api.codacy.com/project/badge/Grade/a87445f769c04ad3863dad750abbb321["Codacy code quality", link="https://www.codacy.com/gh/AY1920S2-CS2103T-W17-4/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S2-CS2103T-W17-4/main&utm_campaign=Badge_Grade"]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,22 +15,44 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
+TA-Tracker
+is a productivity tool made for *NUS School of Computing (SoC) Teaching Assistants (TAs)*
+who want to be able to track and manage their *students* and *claimable
+hours* in one place.
+
+Teaching Assistants at SoC have to keep a track of:
+
+* claimable hours so that they can fill up the TSS Claims form at the end of each semester.
+* teaching-related sessions with claimable hours
+* students and their contact information
+* students' participation marks
+* notes for certain students (such as recommendations)
+
+Rather than managing this through several excel
+spreadsheets and notes, TA-Tracker
+allows TAs to track everything in a single, convenient-to-use
+platform.
+
+In particular, TA-Tracker
+is a *Command Line Interface (CLI)* application packaged
+with a *Graphical User Interface (GUI)*. This means that users are expected to interact
+with the TA-Tracker
+mainly through the command line, and each command executed will
+evoke a visual response in the TA-Tracker.
 
 == Site Map
 
-* <<UserGuide#, User Guide>>
-* <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
-* <<AboutUs#, About Us>>
-* <<ContactUs#, Contact Us>>
+* https://github.com/AY1920S2-CS2103T-W17-4/main/blob/master/docs/UserGuide.adoc[User Guide]
+* https://github.com/AY1920S2-CS2103T-W17-4/main/blob/master/docs/DeveloperGuide.adoc[Developer Guide]
+* https://github.com/AY1920S2-CS2103T-W17-4/main/blob/master/docs/AboutUs.adoc[About Us]
+* https://github.com/AY1920S2-CS2103T-W17-4/main/blob/master/docs/ContactUs.adoc[Contact Us]
 
 == Acknowledgements
 
 * Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
 _Marco Jakob_.
 * Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* TA-Tracker is a brownfield project based on the https://github.com/nus-cs2103-AY1920S2/addressbook-level3[AddressBook-Level3]
+  project created by https://se-education.org[SE-EDU initiative].
 
 == Licence : link:LICENSE[MIT]

build.gradle

@@ -8,14 +8,15 @@ plugins {
     id 'java'
     id 'jacoco'
     id 'checkstyle'
+    id 'pmd'
     id 'com.github.kt3k.coveralls' version '2.4.0'
     id 'com.github.johnrengelman.shadow' version '4.0.4'
     id 'org.asciidoctor.convert' version '1.5.6'
     id 'application'
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.Main'
+mainClassName = 'tatracker.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -41,6 +42,29 @@ test {
     useJUnitPlatform()
 }
 
+apply plugin: 'findbugs'
+findbugs {
+    ignoreFailures = false
+    toolVersion = "3.0.1"
+    sourceSets=[sourceSets.main]
+    reportsDir = file("$project.buildDir/reports/findbugs")
+    effort = "max"
+}
+tasks.withType(FindBugs) {
+    reports {
+        xml.enabled false
+        html.enabled true
+    }
+}
+
+
+pmd {
+    toolVersion = '6.22.0'
+    ignoreFailures = true
+    sourceSets = [sourceSets.main]
+    reportsDir = file("$project.buildDir/reports/pmd")
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -67,7 +91,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'TaTracker.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -133,8 +157,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level3',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level3',
+        'site-name': 'TA-Tracker',
+        'site-githuburl': 'https://github.com/AY1920S2-CS2103T-W17-4/main',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

docs/AboutUs.adoc

@@ -4,53 +4,71 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
-{empty} +
+Acknowledgements: Based on the AddressBook-Level3 project created by https://se-education.org[SE-EDU initiative]. +
+
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== GABRIEL BENEDICT TEO JIAN CHENG
+image::potatocombat.png[flip = "90", width = "150", align = "left"]
+{empty} [https://github.com/PotatoCombat[github]] [<<potatocombat#, portfolio>>]
+
+Role: Project Lead +
+Responsibilities:
 
-Role: Project Advisor
+* Scheduling and Tracking
+* Technical Support
+* Logic Designer
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== AAKANKSHA RAI
+image::aakanksha-rai.png[width="150", align="left"]
+{empty}[https://github.com/aakanksha-rai[github]] [<<aakanksha-rai#, portfolio>>]
+
+Role: Developer +
+Responsibilities:
 
-Role: Team Lead +
-Responsibilities: UI
+* Deliverables and Deadlines
+* PlantUML Expert
+* Student View Creator
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== CHUA YI JING
+image::chuayijing.png[width="150", align="left"]
+{empty}[https://github.com/chuayijing[github]] [<<Chuayijing#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Data
+Responsibilities:
+
+* Session View Creator
+* Testing
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== FATIN NABILAH BTE SUHAIMI
+image::fatin99.png[width="150", align="left]
+{empty}[https://github.com/fatin99[github]] [<<fatin99#, portfolio>>]
 
 Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities:
+
+* UI Designer
+* Documentation and Code Quality
+* Claims View Creator
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== HUANG HAOYI
+image::eclmist.png[width="150", align="left"]
+{empty}[https://github.com/Eclmist[github]] [<<johndoe#, portfolio>>]
 
 Role: Developer +
-Responsibilities: UI
+Responsibilities:
+
+* Integration
+* Report Window Creator
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,20 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
-* *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`
+== Bug reports, Suggestions
+
+Post in our https://github.com/AY1920S2-CS2103T-W17-4/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+
+== Email us
+
+You can also reach us at the following emails: +
+Aakanksha Rai: +
+`rai.aakanksha [at] gmail.com` +
+Chua Yi Jing: +
+`yijing.chua [at] gmail.com` +
+Fatin Nabilah Bte Suhaimi: +
+`fatinnbs [at] gmail.com` +
+Gabriel Benedict Teo Jian Cheng: +
+`gtforce [at] gmail.com` +
+Huang Haoyi: +
+`samuel.huanghaoyi [at] gmail.com`

docs/DevOps.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 3 - Dev Ops
+= TA-Tracker - Dev Ops
 :site-section: DeveloperGuide
 :toc:
 :toc-title: