[CS2103T-F12-4] myStudents

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/AY2223S1-CS2103T-F12-4/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2223S1-CS2103T-F12-4/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.
+* This is **a desktop application project for tuition centers**. </br>
+Example usages:
+  * as a student management tool
+  * as a tutor and class management tool
+
+* The project aims to provide tuition centers with a desktop application (called _myStudent_) to manage admin matters.
+  * It allows the **storing of student particulars**.
+  * It allows **management of the classes and tutors**. For example, it comes with tutor assignment and student allocation capabilities.
+  * It provides **tracking of student performance and fee payment status**.
+
+* It is named `myStudent` because it is created for admin staff to manage the center's own students.
+
+* For the detailed documentation of this project, see the **[myStudent Product Website](https://ay2223s1-cs2103t-f12-4.github.io/tp/)**.
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -40,6 +40,14 @@ task coverage(type: JacocoReport) {
     }
 }
 
+tasks.withType(JavaCompile) {
+    options.compilerArgs << '-Xlint:unchecked'
+}
+
+tasks.withType(JavaExec) {
+    enableAssertions = true
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -59,14 +67,15 @@ dependencies {
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
+    implementation group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-csv', version: '2.7.9'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'myStudent.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,54 @@ 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 `seer@comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Jiang Zhimeng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/asaierika.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/asaierika)]
+[[portfolio](team/asaierika.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: UI
 
-### Jane Doe
+### Loh Teng Wye
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nopehax.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/nopehax)]
+[[portfolio](team/nopehax.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Storage
 
-### Johnny Doe
+### Ong Wen Pin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ongwenpin.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ongwenpin)] [[portfolio](team/ongwenpin.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Model
 
-### Jean Doe
+### Tan Tze Yeong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tantzeyeong.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tantzeyeong)]
+[[portfolio](team/tantzeyeong.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Model
 
-### James Doe
+### Totsuka Tomofumi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/totsukatomofumi.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/totsukatomofumi)] [[portfolio](team/totsukatomofumi.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Logic