[CS2103T-W12-2] SectresBook

README.md

@@ -1,14 +1,26 @@
-[![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-CS2103T-W12-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2223S1-CS2103T-W12-2/tp/actions)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is **a brownfield 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.
+  * Can be used by secretaries and treasurers to manage the club they belong to.
+  * Can also be used to take notes and as a bare-boned address book as well.
+* The project simulates an ongoing software project for a desktop application (called _SectresBook_) 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 `SectresBook` because it is used by Secretaries and Treasurers of clubs to manage their club information.
+* For the detailed documentation of this project, see the **[SectresBook Product Website](https://ay2223s1-cs2103t-w12-2.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+-------------
+
+## Acknowledgements
+
+The background of the program is a large-scale city, attributed to [GiulioDesign94](https://www.deviantart.com/giuliodesign94)'s [Big City](https://www.deviantart.com/giuliodesign94/art/Big-City-198672166).
+
+The icon of this program is an edited image from DepositPhotos, found [here](https://depositphotos.com/471137460/stock-illustration-book-yellow-glowing-neon-icon.html).
+
+The fonts used in this application are [Minion](https://fonts.adobe.com/fonts/minion) by Robert Slimbach and [Bender](https://www.1001fonts.com/bender-font.html) by  Ivan Gladkikh, Oleg Zhuravlev and published by Jovanny Lemonad.
+
+This team recognises that the rights to the images go to their respective owners.

build.gradle

@@ -25,6 +25,10 @@ test {
     finalizedBy jacocoTestReport
 }
 
+run {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -42,7 +46,7 @@ task coverage(type: JacocoReport) {
 
 dependencies {
     String jUnitVersion = '5.4.0'
-    String javaFxVersion = '11'
+    String javaFxVersion = '11.0.2'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'SectresBook.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,67 @@ 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`
+You can reach us on our GitHub portfolios, links provided below.
 
 ## Project team
 
-### John Doe
+### T Neethesh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/neethesh26.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Neethesh26)]
+[[portfolio](team/neethesh26.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities:
+  * Feature (EditLoan, Loan History)
+  * English Proofreading
+  * Meeting coordinator
 
-### Jane Doe
+### Chen Ruihan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/rui-han-crh.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/rui-han-crh)]
+[[portfolio](team/rui-han-crh.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: 
+  * User Interface
+  * Feature (Loans)
+  * English Proofreading
+  * Project Embellishments
 
-### Johnny Doe
+### Ryan Chua
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ryanczx.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ryanczx)]
+[[portfolio](team/ryanczx.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Tags
 
-### Jean Doe
+### Chee Zhong Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/czhongwei.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/czhongwei)]
+[[portfolio](team/czhongwei.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Find, Birthday, Documentation
 
-### James Doe
+### Jiang Pinran
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pinran-j.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/Pinran-J)]
+[[portfolio](team/pinran-j.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities:
+  * Feature (All notes related)
+  * English Proofreading
+  * Team meeting management
+