[CS2103-F09-3] TutorRec

.gitignore

@@ -21,3 +21,7 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+# VSCode files
+.vscode/launch.json
+.vscode/settings.json

README.md

@@ -1,14 +1,21 @@
-[![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/AY2324S2-CS2103-F09-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103-F09-3/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.
+**TutorRec** is a desktop application for tutors to manage client contacts.
+It is
+- CLI based
+- with a simple GUI
+- and super-fast to use.
+
+### Links
+- [Project Website](https://ay2324s2-cs2103-f09-3.github.io/tp/)
+- [User Guide](https://ay2324s2-cs2103-f09-3.github.io/tp/UserGuide.html)
+- [Developer Guide](https://ay2324s2-cs2103-f09-3.github.io/tp/DeveloperGuide.html)
+- [About Us](https://ay2324s2-cs2103-f09-3.github.io/tp/AboutUs.html)
+
+### Acknowledgements
+- 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.

build.gradle

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

docs/AboutUs.md

@@ -9,51 +9,51 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Chin Zhe Ning
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/biinnnggggg.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/biinnnggggg)]
 
-* Role: Project Advisor
+* Roles: Documentation, In charge of `Logic`
+* Responsibilities: looks after quality of various project documents, diagrams and the `Logic` component
+### Jonathan Chong
 
-### Jane Doe
+<img src="images/jonchong98.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](http://github.com/jonchong98)]
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+* Roles: User Interface design and implementation
+* Responsibilities: creating UI mockups and implementing design into product
 
-* Role: Team Lead
-* Responsibilities: UI
 
-### Johnny Doe
+### Darylgolden
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/darylgolden.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/darylgolden)]
 
-* Role: Developer
-* Responsibilities: Data
+* Roles: Git expert, Testing, Integration
+* Responsibilities: helps other team member with Git matters, ensures
+  the testing of the project is timely and done properly, In charge of
+  versioning of the code, maintaining the code repository, integrating
+  various parts of the software to create a whole.
 
-### Jean Doe
+### Aidan Goh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/topkec.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/TopKec)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Code Quality, In charge of `Model` package
+* Responsibilities: looks after code quality, ensures adherence to coding
+standards, etc., looks after quality of `Model` package
 
-### James Doe
+### Tan Qin Yong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tanqinyong.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tanqinyong)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role:  Scheduling and Tracking
+* Responsibilities: in charge of defining, assigning and tracking of tasks