[CS2103-F11-4] BookFace

.gitignore

@@ -10,6 +10,7 @@ src/main/resources/docs/
 
 # Storage/log files
 /data/
+/profile_pictures/
 /config.json
 /preferences.json
 /*.log.*

README.md

@@ -1,14 +1,15 @@
-[![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/AY2223S2-CS2103-F11-4/tp/actions)
+[![codecov](https://codecov.io/gh/AY2223S2-CS2103-F11-4/tp/branch/master/graph/badge.svg?token=WPKLBLHW27)](https://codecov.io/gh/AY2223S2-CS2103-F11-4/tp)
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is BookFace, an NUS-centered address book application.
   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.
+    * Add contacts along with the image of the person
+    * Quickly import university related contacts
+* The project simulates an ongoing software project for a desktop application (called BookFace) used for managing
+  contact details.
+* It is named BookFace because it is an address book organizer with photos of the contacts you save.
+* For the detailed documentation of this project, see
+  the **[BookFace Product Website](https://ay2223s2-cs2103-f11-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

@@ -3,6 +3,7 @@ plugins {
     id 'checkstyle'
     id 'com.github.johnrengelman.shadow' version '7.1.2'
     id 'application'
+    id 'org.openjfx.javafxplugin' version '0.0.13'
     id 'jacoco'
 }
 
@@ -20,11 +21,20 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+javafx {
+    version = "19"
+    modules = [ 'javafx.controls' ]
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -66,7 +76,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'bookface.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,54 @@ 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 Hong Sheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hongshenggg.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/hongshenggg)]
+[[portfolio](team/hongshenggg.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Functions
 
-### Jane Doe
+### Ian
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/castryl.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/castryl)]
+[[portfolio](team/castryl.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: Everything
 
-### Johnny Doe
+### Lum Wee Kiat
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/weekiat-douze.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/weekiat-douze)] [[portfolio](team/weekiat-douze.md)]
 
 * Role: Developer
 * Responsibilities: Data
 
-### Jean Doe
+### Ni Shenghan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/shni99.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/shni99)]
+[[portfolio](team/shni99.md)]
 
 * Role: Developer
 * Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Phone Khant Paing
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pkpaing.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/pkpaing)]
+[[portfolio](team/pkpaing.md)]
 
 * Role: Developer
 * Responsibilities: UI
+