[CS2103-T13-4] Foster Family AB3

README.md

@@ -1,14 +1,12 @@
-[![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/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T13-4/tp/actions)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is **an application for managing animal foster families in non-profit animal shelters** which currently do not have a good logistical workflow to do so.<br>
+* Target user: Foster manager of the animal shelter
+* 
   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.
+  * as a streamlined workflow to **manage list of fosterers**
+  * provides an **intuitive** way to manage fosterers' details, such as their **availability** and **animals they can foster**
+* For the detailed documentation of this project, see the **[Foster Family Product Website](https://ay2324s1-cs2103t-t13-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

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'FosterFamily.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -9,51 +9,47 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Nicole Chiong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/butteredyakiimo.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/butteredyakiimo)]
+[[portfolio](team/butteredyakiimo.md)]
 
-* Role: Project Advisor
+* Role: Deliverables and Deadlines, Code Quality
 
-### Jane Doe
+### Nanette Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nananakx-x.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/nananakx-x)]
+[[portfolio](team/nananakx-x.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Testing
 
-### Johnny Doe
+### Sia Zhi Hong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/h1410101.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/h1410101)]
+[[portfolio](team/h1410101.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Integration
 
-### Jean Doe
+### Nam Dohyun (Brandon)
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/brandon-nam.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/brandon-nam)]
+[[portfolio](team/brandon-nam.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Scheduling and Tracking
 
-### James Doe
+### Tyrus Lye
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tyruslye.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/TyrusLye)]
+[[portfolio](team/tyruslye.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Documentation