[CS2103T-T13-4] TutorTrack

README.md

@@ -1,14 +1,17 @@
-[![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/AY2425S2-CS2103T-T13-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S2-CS2103T-T13-4/tp/actions)
 
 ![Ui](docs/images/Ui.png)
+The product is designed for freelance tutors who teach small groups or individual students. These tutors often manage multiple students across different subjects and require an efficient way to track student progress, lesson schedules, and important notes. The user is proficient in typing and prefers CLI over mouse-based interactions.
 
-* 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.
+### Value Propositions:
+
+Freelance tutors often struggle with managing student records efficiently using scattered documents, spreadsheets, or manual note-taking. Existing software may be too complex, designed for large institutions, or require unnecessary overhead.
+
+Our product provides a CLI-based, lightweight tutor management system that allows tutors to:
+* Quickly organise student contact details.
+* Track lesson schedules.
+* Log student progress.
+
+The project is built upon 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/#contributing-to-se-edu) for more info.

build.gradle

@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'tutortrack.jar'
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}

copyright.txt

@@ -1,5 +1,6 @@
 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
 - AddressApp.ico

docs/AboutUs.md

@@ -9,51 +9,52 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Charles
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/charlesl12.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/charlesl12)]
+[[portfolio](team/charlesl12.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Code quality + Testing
 
-### Jane Doe
+### Nicholas Oh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nicholasohjj.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](http://www.comp.nus.edu.sg/~nohjj)]
+[[github](https://github.com/nicholasohjj)]
+[[portfolio](team/nicholasohjj.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: Documentation, deliverables and deadlines
 
-### Johnny Doe
+### Guan Zhong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gztan23.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/gztan23)]
+[[portfolio](team/gztan23.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Code quality
 
-### Jean Doe
+### Yan Andong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/andong0909.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/andong0909)] [[portfolio](team/andong.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Data
 
-### James Doe
+### Wang Zimeng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jiangsuwangjing.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jiangsuwangjing)]
+[[portfolio](team/jiangsuwangjing.md)]
 
 * Role: Developer
 * Responsibilities: UI