[CS2103-W14-1] Condonery

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/AY2223S1-CS2103-W14-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S1-CS2103-W14-1/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.
+* Condonery is a Condonery is a desktop app made for property agents primarily used for managing client contacts and condo listings. It is optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Condonery can get your contact management tasks done faster than traditional GUI apps.
+
+
+Example usages:
+  * managing multiple property listings
+  * storing client contact details
+
+Getting started:
+  * This project uses gradle as a build tool, to get started:
+```bash
+> ./gradlew clean run
+```
+  * The project is a desktop application used for managing contact details.
+    * It is **written in OOP fashion**. It provides a **reasonably well-written** code base(around 6 KLoC), without being overwhelmingly big.
+    * It comes with a **reasonable level of user and developer documentation**.
+  * It is named `Condonery` and was evolved from `AddressBook` project.
+  * For the detailed documentation of this project, see the **[Condonery Product Website](https://ay2223s1-cs2103-w14-1.github.io/tp/)**.

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'seedu.condonery.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -18,6 +18,7 @@ repositories {
 
 checkstyle {
     toolVersion = '10.2'
+    checkstyleTest.enabled = true
 }
 
 test {
@@ -56,6 +57,14 @@ 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-media', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'linux'
+
+    implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0'
 
     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'
@@ -66,7 +75,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'condonery.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -9,51 +9,57 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Zacchaeus Chok
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zacchaeuschok.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/zacchaeuschok)]
+[[portfolio](team/zacchaeuschok.md)]
 
-* Role: Project Advisor
+* Role: Code Zebra
+* Responsibilities: Generate code + testing + documentation
 
-### Jane Doe
+### Sng Haoren
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/misterpuffin.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/misterpuffin)]
+[[portfolio](team/misterpuffin.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Code Monkey
+* Responsibilities: Generate code
 
-### Johnny Doe
+### Zhao Yige
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/frrramses.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/frrramses)] [[portfolio](team/frrramses.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Code Crocodile
+* Responsibilities: Random Ideas & Random Codes
 
-### Jean Doe
+### Kang Yue Hern
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yuehernkang.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/yuehernkang)]
+[[portfolio](team/yuehernkang.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: 
+  * Updating of commands to support the editing and usage of Property and Client class
+  * Implementing of filter by PropertyStatus commands
+  * In charge of Testing
 
-### James Doe
+### Lee Kang Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lkwlkww.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/lkwlkww)]
+[[portfolio](team/lkwlkww.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Code Chicken
+* Responsibilities:
+    * Select feature
+    * Interested properties/clients enhancement
+    * Ensure good code quality