[CS2103T-T12-4] TutAssistor

README.md

@@ -1,14 +1,27 @@
-[![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/ay2122s1-cs2103t-t12-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2122S1-CS2103T-T12-4/tp/actions)
+
+<p align="center">
+  <img src="docs/images/ta_logo_cropped_white_bg.png">
+  <p><h1>Welcome to TutAssistor!</h1></p>
+</p>
 
 ![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.
+### Description
+TutAssistor is a tool for private tutors to keep track of their students and classes. With TutAssistor, you can manage many different classes and students, and facilitate deconfliction of time slots.
+
+### Features
+* Add and edit student contact information.
+* Create classes with fixed timeslots and student limit to prevent overbooking.
+* Add Tags to students and classes for easier searching.
+* Add and edit Notes for students and classes to keep track of miscellaneous information.
+* Search and filter students by timeslot, subject, day, etc.
+*	Add/view/change time slots for students.
+* Be informed of whether or not time slots are fully booked.
+
+### Project information
+* This project was made as part of a student project for NUS CS2103T AY21/22 S1.
+* For the detailed documentation of this project, see the **[TutAssistor Website](https://ay2122s1-cs2103t-t12-4.github.io/tp/)**.
+
+### Acknowledgements
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -56,6 +56,9 @@ dependencies {
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-swing', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-swing', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-swing', version: javaFxVersion, classifier: 'linux'
 
     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'
@@ -65,6 +68,10 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+run {
+    enableAssertions = true
+}
+
 shadowJar {
     archiveName = 'addressbook.jar'
 }

docs/AboutUs.md

@@ -3,57 +3,61 @@ layout: page
 title: About Us
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
+We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg). This project team was formed for the module CS2103T in AY21/22 Sem 1.
+
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Timothy Ng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/timiditi.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
-* Role: Project Advisor
+[[github](https://github.com/timiditi)]
+[[portfolio](team/timiditi.md)]
 
-### Jane Doe
+* Role: Team Lead
+* Responsibilities: Documentation
 
-<img src="images/johndoe.png" width="200px">
+### Mohamed Ammar Zumana Haseen
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/amzhy.png" width="200px">
 
-* Role: Team Lead
-* Responsibilities: UI
+[[github](http://github.com/amzhy)]
+[[portfolio](team/amzhy.md)]
 
-### Johnny Doe
+* Role: Developer
+* Responsibilities: Ensures the testing of the project is done properly on time
 
-<img src="images/johndoe.png" width="200px">
+### Deng Huaiyu
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/norayuuu.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Data
+[[github](https://github.com/NoraYUuu)]
+[[portfolio](team/norayuuu.md)]
 
-### Jean Doe
+* Role: Code Quality
+* Responsibilities: Looks after code quality and ensures adherence to coding standards.
 
-<img src="images/johndoe.png" width="200px">
+### Adam Ho
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/adam-ky.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+[[github](http://github.com/adam-ky)]
+[[portfolio](team/adam-ky.md)]
+* Role: Time Keeper
+* Responsibilities: In charge of defining, assigning, and tracking project tasks. Ensure project deliverables are done on time.
+
+
+
+### Feng Zhunyi
 
-### James Doe
+<img src="images/leofeng10.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/Leofeng10)]
+[[portfolio](team/leofeng10.md)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Integration