[CS2103T-W10-2] PoochPlanner

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/AY2324S2-CS2103T-W10-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W10-2/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.
+## PoochPlanner
+This is an **address book for dog cafe owners**.<br>
+Example usages:
+* as an address book to store contacts
+
+The project simulates an ongoing software project for a desktop application (called _PoochPlanner_) 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.
+* It is named `PoochPlanner` because it is meant for pooch (dog) cafe owners to manage their address books.
+* For the detailed documentation of this project, see **[PoochPlanner's Product Website](https://ay2324s2-cs2103t-w10-2.github.io/tp/)**.
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport

docs/AboutUs.md

@@ -5,55 +5,53 @@ 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`
-
 ## Project team
 
-### John Doe
+### Lee Yi Lin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yleeyilin.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/yleeyilin)]
+[[portfolio](team/yleeyilin.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Code Quality
 
-### Jane Doe
+### James Sin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jamessinmaojun.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/jamessinmaojun)]
+[[portfolio](team/jamessinmaojun.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Documentation
 
-### Johnny Doe
+### Leong Jia Yi, Janna
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jannaleong.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/jannaleong)] [[portfolio](team/jannaleong.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Team Lead
+* Responsibilities: Overall project coordination, deliverables and deadlines
 
-### Jean Doe
+### Joshua Yip Sujun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/joshy837.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/joshy837)]
+[[portfolio](team/joshy837.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Testing
 
-### James Doe
+### Chng Chia Geng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/chiageng.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/chiageng)]
+[[portfolio](team/chiageng.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Integration