[CS2103-W15-3] Teaching Assistant Contact Helper (TACH)

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)
+[![CI Status](https://github.com/AY2122S2-CS2103T-W15-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S2-CS2103T-W15-3/tp/actions)
 
 ![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.
+## Teaching Assistant Contact Helper (TACH)
+
+* This is a team project for a desktop application (called **TACH**) used by Computer Science (**CS**)
+Teaching Assistants (**TA**s) in NUS to manage and keep track of their students in
+the TAs tutorial groups.
+* **TACH** aims to solve problems of CS TAs regarding management and alleviate their workload by:
+  * Managing their students in an organised manner
+  * Easily access a student's contact details like their email or Telegram
+  * Find students either by their name or by their tutorial group
+* It is named `Teaching Assistant Contact Helper` (`TACH` for short) because it helps TAs with their students' contacts.
+* For detailed documentation of this project, see the
+**[TACH Product Website](https://ay2122s2-cs2103t-w15-3.github.io/tp/)**
+* This project is based on the AddressBook-Level3 project created by the
+[SE-EDU initiative](https://se-education.org).
+

build.gradle

@@ -14,6 +14,7 @@ targetCompatibility = JavaVersion.VERSION_11
 repositories {
     mavenCentral()
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
+    maven {url "https://sandec.jfrog.io/artifactory/repo"}
 }
 
 checkstyle {
@@ -25,6 +26,10 @@ test {
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -44,6 +49,9 @@ dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
 
+    compile 'org.apache.directory.studio:org.apache.commons.io:2.4'
+    compile "com.sandec:mdfx:0.2.4"
+
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'

docs/AboutUs.md

@@ -5,55 +5,48 @@ 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`
+You can reach us at the email `[email protected]`
 
 ## Project team
 
-### John Doe
+### Low Jia Hao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lowjiahao99.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/LowJiaHao99)]
+[[portfolio](team/lowjiahao99.md)]
 
-* Role: Project Advisor
+* Role: Team lead
+* Responsibilities: Model and API testing
 
-### Jane Doe
+### Lim Jan Jay
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jaysmyname.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Team Lead
-* Responsibilities: UI
-
-### Johnny Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/jaysmyname)]
+[[portfolio](team/jaysmyname.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI and GUI testing
 
-### Jean Doe
+### Huang Qing
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hqhqhq1.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/hqhqhq1)]
+[[portfolio](team/hqhqhq1.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Storage, code quality, deliverables, deadlines, Scheduling and tracking
+
 
-### James Doe
+### Khor Vanessa
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/vanessaxuuan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/vanessaxuuan)]
+[[portfolio](team/vanessaxuuan.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Integration, logic and documentation
+