[CS2103T-F12-3] TutorPro

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/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-F12-3/tp/actions)
+
+[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-F12-3/tp/graph/badge.svg?token=6NOAZHAJVS)](https://codecov.io/gh/AY2324S2-CS2103T-F12-3/tp)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is **a CS2103T project by NUS Computing 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.
+* The project simulates an ongoing software project for a desktop application (called _TutorPro_) used by private tutors for managing their students. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
   * 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.
+* It is named `TutorPro Level 1` (`TP-1` for short) because it was initially created as a part of a series of `TutorPro` projects (`Level 1`, `Level 2`, `Level 3` ...).
+* For the detailed documentation of this project, see the **[tutorpro.github.io](https://ay2324s2-cs2103t-f12-3.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the **[SE-EDU initiative](https://se-education.org)**. 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.

build.gradle

@@ -6,7 +6,11 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+run {
+    enableAssertions = true
+}
+
+mainClassName = 'tutorpro.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'tutorpro.jar'
 }
 
 defaultTasks 'clean', 'test'

codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "src/main/java/tutorpro/ui/StudentCard.java"

docs/AboutUs.md

@@ -5,55 +5,43 @@ 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 [e0960433@u.nus.edu]([email protected])
 
 ## Project team
 
-### John Doe
+### Carsten Joe Ng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/wyrkx.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/wyrkx)]
+[[portfolio](team/carsten.md)]
 
-* Role: Project Advisor
+- Role: Team Lead
+- Responsibilities: UI
 
-### Jane Doe
+### Pairor Tarin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tarinpairor.png" width="190px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/TarinPairor)]
+[[portfolio](team/tarinpairor.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+### Lee Xin Yuan
 
-### Johnny Doe
+<img src="images/agreatdayy.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/agreatdayy)]
+[[portfolio](team/xinyuan.md)]
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+- Role: Developer
+- Responsibilities: UI
 
-* Role: Developer
-* Responsibilities: Data
+### Tee Chu Jie
 
-### Jean Doe
+<img src="images/tamagochuuu.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/tamagochuuu)]
+[[portfolio](team/chujie.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
-
-### James Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Developer
-* Responsibilities: UI
+- Role: Developer
+- Responsibilites: Dev Ops