[CS2103-W11-3] AcademyAssist

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/AY2425S1-CS2103T-W11-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-W11-3/tp/actions)
 
+# Academy Assist
 ![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/#contributing-to-se-edu) for more info.
+**AcademyAssist** is a specialized contact management system designed for **small to medium-sized tuition centers** catering to **primary school** students. It streamlines **administrative tasks** and improves organizational efficiency by centralizing student's information.
+
+#### Project Details
+* **AcademyAssist** is a desktop application for managing student information
+  * It is optimized for use via a **Command Line Interface (CLI)** while still having the benefits of a Graphical User Interface (GUI).
+* **AcademyAssist** is written in **Java**.
+* For the detailed information about the project, see the **[AcademyAssist Product Website](https://ay2425s1-cs2103t-w11-3.github.io/tp/)**.
+
+
+#### Acknowledgements
+The project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.academyassist.Main'
 
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -61,12 +65,13 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
+    testImplementation 'org.junit.jupiter:junit-jupiter-params:5.8.1'
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'academyassist.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,49 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](https://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 `AcademyAssist@gmail.com`
 
 ## Project team
 
-### John Doe
 
-<img src="images/johndoe.png" width="200px">
+### Ethan Wang
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/ethanwangkangen.png" width="200px">
 
-* Role: Project Advisor
+[[github](https://github.com/ethanwangkangen)]
+[[portfolio](team/ethanwang.md)]
 
-### Jane Doe
+### Hing Yen Xing (Joanne)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/joannehing.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](https://github.com/joannehing)]
 [[portfolio](team/johndoe.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
 
-### Johnny Doe
+### Khoo Yu Yien (Annabelle)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/annabellekk.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/annabellekk)]
+[[portfolio](team/johndoe.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI
 
-### Jean Doe
+### Adrian Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/adriantan101.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/adriantan101)] [[portfolio](team/adriantan.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+### Chong Wei Jin
 
-### James Doe
+<img src="images/cweijin.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/cweijin)] [[portfolio](team/johndoe.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Data