[CS2103T-W13-4] Teaching Assistant

README.md

@@ -1,14 +1,16 @@
-[![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/AY2021S2-CS2103T-W13-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S2-CS2103T-W13-4/tp/actions)
+
+# Teaching Assistant
+Teaching Assistant is a desktop application that provides Secondary School or Junior College teachers with an efficient tool to keep track of their **schedules, contacts and tasks** easily.
+While it has a GUI, most of the user interactions rely on typing commands as user inputs.
 
 ![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.
+## Getting Started
+Head over to the [User Guide](https://github.com/AY2021S2-CS2103T-W13-4/tp/blob/master/docs/UserGuide.md) to start using Teaching Assistant!
+
+## Developer Guide
+Take a look at our [Developer Guide](https://github.com/AY2021S2-CS2103T-W13-4/tp/blob/master/docs/DeveloperGuide.md) if you want to know more about our project.
+
+## Authors
+Teaching Assistant is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org) and will be maintained by [our team](https://github.com/AY2021S2-CS2103T-W13-4/tp/blob/master/docs/AboutUs.md).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.ta.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '8.29'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'teachingAssistant.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -7,53 +7,49 @@ We are a team based in the [School of Computing, National University of Singapor
 
 You can reach us at the email `seer[at]comp.nus.edu.sg`
 
-## Project team
+## Team Members
 
-### John Doe
+### Lee Rong Jieh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lrj689.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/lrj689)]
+[[portfolio](team/lrj689.md)]
 
-* Role: Project Advisor
+### Loh Jun Yong Kevin
 
-### Jane Doe
+<img src="images/kevinlohjunyong.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/kevinlohjunyong)]
+[[portfolio](team/kevinlohjunyong.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Nicholas Tanvis
 
-* Role: Team Lead
-* Responsibilities: UI
+<img src="images/nicholastanvis.png" width="200px">
 
-### Johnny Doe
+[[github](http://github.com/nicholastanvis)]
+[[portfolio](team/nicholastanvis.md)]
 
-<img src="images/johndoe.png" width="200px">
+### Shen Yang
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/goatygoatygoat.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Data
+[[github](http://github.com/goatygoatygoat)]
+[[portfolio](team/goatygoatygoat.md)]
 
-### Jean Doe
+### Toh Sihui
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tsh22.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tsh22)]
+[[portfolio](team/tsh22.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+## Responsibilities
 
-### James Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Developer
-* Responsibilities: UI
+Member | Responsibility 1 | Responsibility 2
+-- | -- | --
+Rong Jieh | Deliverables | Entry IC
+Kevin Loh | Documentation | Entry IC
+Nicholas | Testing | Contact IC
+Shen Yang | Code Quality | Scheduling
+Toh Sihui | Tool Expert | Integration

docs/DevOps.md

@@ -44,7 +44,7 @@ As part of CI, this project uses Codecov to generate coverage reports. Here are
 
 1. Sign up with Codecov using your GitHub account [here](https://codecov.io/signup).
 1. Once you are inside Codecov web app, add your fork to 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/AY2021S2-CS2103T-W13-4/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S2-CS2103T-W13-4/tp) in that page reflects the coverage of your project.
 
 ### Repository-wide checks
 
@@ -73,7 +73,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/AY2021S2-CS2103T-W13-4/tp/tree/master/src/main/java/seedu/ta/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadow`).
 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.