[CS2103-F10-3] BizBook

.github/check-line-endings.sh

@@ -1,8 +1,9 @@
 #!/bin/sh
 # Checks for prohibited line endings.
 # Prohibited line endings: \r\n
+# Exclude .vcf files as the RFC states that they must use \r\n
 
-git grep --cached -I -n --no-color -P '\r$' -- ':/' |
+git grep --cached -I -n --no-color -P '\r$' -- ':/' ':/!*.vcf' |
 awk '
     BEGIN {
         FS = ":"

.gitignore

@@ -1,23 +1,28 @@
 # Gradle build files
 /.gradle/
 /build/
-src/main/resources/docs/
+/src/main/resources/docs/
+
+# Vscode files
+/.vscode/
 
 # IDEA files
 /.idea/
 /out/
 /*.iml
+/bin
 
 # Storage/log files
+/exports/
 /data/
 /config.json
 /preferences.json
 /*.log.*
-hs_err_pid[0-9]*.log
+/hs_err_pid[0-9]*.log
 
 # Test sandbox files
-src/test/data/sandbox/
+/src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
-docs/_site/
+/docs/_site/

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/AY2425S1-CS2103-F10-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103-F10-3/tp/actions) [![codecov](https://codecov.io/gh/AY2425S1-CS2103-F10-3/tp/graph/badge.svg?token=XDT6OIN0I7)](https://codecov.io/gh/AY2425S1-CS2103-F10-3/tp)
 
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is an **address book application catered towards B2B Sales Representatives in the Food and Beverage Industry**.<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.
+  * as a tool to more easily retrieve information from clients to improve overall workflow efficiency
+* The project builds on a 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/#contributing-to-se-edu) for more info.
+* It is named `BizBook` as it aims to improve the workflow of business to business dealings by prioritizing efficiency and offering features specific to this target demographic.
+* For the detailed documentation of this project, see the **[BizBook Website](https://ay2425s1-cs2103-f10-3.github.io/tp/)**.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* This projects icon was created using [canva](https://www.canva.com).
+

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'bizbook.Main'
 
 sourceCompatibility = JavaVersion.VERSION_17
 targetCompatibility = JavaVersion.VERSION_17
@@ -41,7 +41,7 @@ task coverage(type: JacocoReport) {
 }
 
 dependencies {
-    String jUnitVersion = '5.4.0'
+    String jUnitVersion = '5.10.0'
     String javaFxVersion = '17.0.7'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
@@ -57,16 +57,23 @@ dependencies {
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
 
-    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'
+    implementation 'com.googlecode.ez-vcard:ez-vcard:0.12.1'
+
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.18.0'
+    implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.18.0'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
+    testImplementation 'org.mockito:mockito-core:4.8.0' // Mockito core
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'bizbook.jar'
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}

config/checkstyle/checkstyle.xml

@@ -418,6 +418,9 @@
       <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
     </module>
 
+    <!-- (Not part of cs2103) Checks that there is a newline before tags e.g. @see, @params  -->
+    <module name="RequireEmptyLineBeforeBlockTagGroup"/>
+
     <module name="InvalidJavadocPosition"/>
 
     <!-- Checks that every public method (excluding getters, setters and constructors) has a header comment. -->

docs/AboutUs.md

@@ -5,55 +5,57 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+If you have any suggestions or comments feel free to post them in the `Issues` page of our project [repository](https://github.com/AY2425S1-CS2103-F10-3/tp)!
 
 ## Project team
 
-### John Doe
+### Nicholas Cheng De Fei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/nicholas-cheng-de-fei.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Nicholas-Cheng-De-Fei)]
+[[linkedin](https://www.linkedin.com/in/nicholas-cheng-)]
 
-* Role: Project Advisor
+- Role: Team Lead
+- Responsibilities: Project Coordination, VScode Expert
 
-### Jane Doe
+### Joel Tio
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/joeltio.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[website](https://joelt.io)]
+[[github](https://github.com/joeltio)]
+[[linkedin](https://www.linkedin.com/in/joel-tio)]
 
-* Role: Team Lead
-* Responsibilities: UI
+- Role: Developer
+- Responsibilities: Code Quality, Git Expert
 
-### Johnny Doe
+### Lim Jia Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/itlimjiawei.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/ITLimJiaWei)]
+[[linkedin](https://www.linkedin.com/in/jiawei88)]
 
-* Role: Developer
-* Responsibilities: Data
+- Role: Developer
+- Responsibilities: Testing, IntelliJ Expert
 
-### Jean Doe
+### Kenneth Teo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kennethteo2002.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/KennethTeo2002)]
+[[linkedin](https://www.linkedin.com/in/kenneth-teo-boon-jun)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+- Role: Developer
+- Responsibilities: Integration, Deliverables and deadlines
 
-### James Doe
+### Sheen
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/sheenkerr.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/sheenkerr)]
+[[linkedin](https://www.linkedin.com/in/sheenkerr)]
 
-* Role: Developer
-* Responsibilities: UI
+- Role: Developer
+- Responsibilities: Documentation

docs/DevOps.md

@@ -73,7 +73,7 @@ Any warnings or errors will be printed out to the console.
 
 Here are the steps to create a new release.
 
-1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
+1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/bizbook/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
 1. Tag the repo with the version number. e.g. `v0.1`
 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.