[T16-2] SuperTA

.gitignore

@@ -3,12 +3,13 @@ build/
 .checkstyle
 .settings/
 .idea/
+.project
+.classpath
 lib/*
 *.iml
 *.log
 *.log.*
 *.csv
-config.json
 src/test/data/sandbox/
 preferences.json
 .DS_Store
@@ -18,3 +19,4 @@ classes/
 /bin/
 src/main/resources/docs/
 out/
+.vscode/

LICENSE

@@ -2,11 +2,11 @@ MIT License
 
 Copyright (c) 2016 Software Engineering Education - FOSS Resources
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any student obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
+copies of the Software, and to permit students to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all

README.adoc

@@ -1,40 +1,41 @@
-= Address Book (Level 4)
+= SuperTA
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
-https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://travis-ci.org/CS2103-AY1819S1-T16-2/main[image:https://travis-ci.org/CS2103-AY1819S1-T16-2/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/Caephler/main[image:https://ci.appveyor.com/api/projects/status/nf0mimtyhamj6l8e?svg=true[Build status]]
+https://coveralls.io/github/CS2103-AY1819S1-T16-2/main?branch=master[image:https://coveralls.io/repos/github/CS2103-AY1819S1-T16-2/main/badge.svg?branch=master[Coverage Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
 endif::[]
 
-ifndef::env-github[]
-image::images/Ui.png[width="600"]
+Welcome to SuperTA, the one-stop station to help YOU become the ultimate teaching assistant (TA). Say no more to attendance sheets, Excel spreadsheets and feedback forms!
+
+ifdef::env-github[]
+image::docs/images/Ui2.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.
-* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
-** A more sophisticated GUI that includes a list  panel and an in-built Browser.
-** More test cases, including automated GUI testing.
-** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
+SuperTA is a desktop management application made for TAs to keep track on students progress and attendance. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
+
+With just a few simple commands, you can
+
+* Search for student records
+* take and track attendance of each student
+* record and view feedback for each student
+* and many more.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
 == Acknowledgements
 
+* This application is built and enhanced from https://github.com/se-edu/addressbook-level4[se-edu/addressbook-level 4]
 * 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://github.com/TestFX/TestFX[TextFX], https://bitbucket.org/controlsfx/controlsfx/[ControlsFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/google/guava[Guava], https://github.com/junit-team/junit5[JUnit5]
 
-== Licence : link:LICENSE[MIT]
+== License : link:LICENSE[MIT]

_reposense/config.json

@@ -0,0 +1,34 @@
+{
+  "authors":
+  [
+    {
+      "githubId": "caephler",
+      "displayName": "Gabriel Tan",
+      "authorNames": ["caephler", "Caephler", "Gabriel", "plehr"]
+    },
+    {
+      "githubId": "keithtan",
+      "displayName": "Keith Tan",
+      "authorNames": ["keithtan", "Keith Tan", "KEITHTAN\\keithtan"]
+    },
+    {
+      "githubId": "triger15",
+      "displayName": "Ong Yu-He",
+      "authorNames": ["Ong Yu-He", "triger15", "Yuhe"]
+    },
+    {
+      "githubId": "darieca",
+      "displayName": "Darieca Lim",
+      "authorNames": ["darieca"]
+    },
+    {
+      "githubId": "wenshei",
+      "displayName": "Ong Wen Shei",
+      "authorNames": ["wenshei", "WenShei"]
+    }
+  ],
+  "ignoreCommitList": [
+    "207f16434ff5a2893334dc967fd3806ca3d2eda6",
+    "a353b6568e2ef421ab856fa503a6286170be72ca"
+  ]
+}

build.gradle

@@ -28,7 +28,7 @@ if (JavaVersion.current() == JavaVersion.VERSION_1_10
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.MainApp'
+mainClassName = 'seedu.superta.MainApp'
 
 sourceCompatibility = JavaVersion.VERSION_1_9
 targetCompatibility = JavaVersion.VERSION_1_9
@@ -82,7 +82,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'superta.jar'
 
     destinationDir = file("${buildDir}/jar/")
 }
@@ -157,16 +157,16 @@ test {
         }
 
         if (runNonGuiTests) {
-            test.include 'seedu/address/**'
+            test.include 'seedu/superta/**'
         }
 
         if (runGuiTests) {
             test.include 'systemtests/**'
-            test.include 'seedu/address/ui/**'
+            test.include 'seedu/supertai/ui/**'
         }
 
         if (!runGuiTests) {
-            test.exclude 'seedu/address/ui/**'
+            test.exclude 'seedu/superta/ui/**'
         }
     }
 }
@@ -207,8 +207,8 @@ asciidoctor {
         idprefix: '',  // for compatibility with GitHub preview
         idseparator: '-',
         'site-root': "${sourceDir}",  // must be the same as sourceDir, do not modify
-        'site-name': 'AddressBook-Level4',
-        'site-githuburl': 'https://github.com/se-edu/addressbook-level4',
+        'site-name': 'SuperTA',
+        'site-githuburl': 'https://github.com/CS2103-AY1819S1-T16-2/main/',
         'site-seedu': true,  // delete this line if your project is not a fork (not a SE-EDU project)
     ]
 

check.sh

@@ -0,0 +1,2 @@
+./config/travis/run-checks.sh &&
+./gradlew clean checkstyleMain checkstyleTest headless allTests coverage coveralls asciidoctor copyDummySearchPage

checkstyle.sh

@@ -0,0 +1,2 @@
+./config/travis/run-checks.sh &&
+./gradlew clean checkstyleMain checkstyleTest

config.json

@@ -0,0 +1,5 @@
+{
+  "appTitle" : "SuperTA",
+  "logLevel" : "INFO",
+  "userPrefsFilePath" : "preferences.json"
+}

config/checkstyle/checkstyle.xml

@@ -33,9 +33,6 @@
   <!-- All Java AST specific tests live under TreeWalker module. -->
   <module name="TreeWalker">
 
-    <!-- Required for SuppressionCommentFilter to work -->
-    <module name="FileContentsHolder"/>
-
     <!-- Required to allow exceptions in code style -->
     <module name="SuppressionCommentFilter">
       <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>

config/travis/check-trailing-whitespace.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 # Checks for trailing whitespace
 
-git grep --cached -I -n --no-color -P '[ \t]+$' -- ':/' |
+git grep -I -n --no-color -P '[ \t]+$' -- ':/' |
 awk '
     BEGIN {
         FS = ":"

copyright.txt

@@ -1,4 +1,4 @@
-Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
+Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
 
 Copyright by Susumu Yoshida - http://www.mcdodesign.com/
 - address_book_32.png

docs/AboutUs.adoc

@@ -4,53 +4,47 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 4 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} +
+SuperTA was developed by the CS2103T T16-2 team. +
 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
+image::caephler.png[width="150", align="left"]
+{empty}[https://blog.caephler.com[homepage]] [https://github.com/caephler[github]] [<<caephler#, portfolio>>]
 
-Role: Project Advisor
+Responsibilities: Team Lead, Integration
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Keith Tan
+image::keithtan.png[width="150", align="left"]
+{empty}[http://github.com/keithtan[github]] [<<keithtan#, portfolio>>]
 
-Role: Team Lead +
-Responsibilities: UI
+Responsibilities: Documentation
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Yu-He Ong
+image::triger15.png[width="150", align="left"]
+{empty}[http://github.com/triger15[github]] [<<triger15#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Data
+Responsibilities: Code Quality
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Darieca Lim
+image::darieca.png[width="150", align="left"]
+{empty}[http://github.com/darieca[github]] [<<darieca#, portfolio>>]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Responsibilities: Testing
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Wenshei Ong
+image::wenshei.png[width="150", align="left"]
+{empty}[http://github.com/wenshei[github]] [<<wenshei#, portfolio>>]
 
-Role: Developer +
-Responsibilities: UI
+Responsibilities: Deliverables/Deadlines, Scheduling and Tracking
 
 '''

docs/ContactUs.adoc

@@ -2,6 +2,6 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level4/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/CS2103-AY1819S1-T16-2/main/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`
+* *Email us* : You can also reach us at `gabriel [at] comp.nus.edu.sg`