[CS2103-F08-3] PawFection

.github/check-eof-newline.sh

@@ -7,7 +7,7 @@ ret=0
 IFS='
 '
 
-for filename in $(git grep --cached -I -l -e '' -- ':/'); do
+for filename in $(git grep -I -l -e '' -- ':/'); do
     if [ "$(tail -c 1 "./$filename")" != '' ]; then
         line="$(wc -l "./$filename" | cut -d' ' -f1)"
         echo "ERROR:$filename:$line: no newline at EOF."

.github/check-line-endings.sh

@@ -2,7 +2,7 @@
 # Checks for prohibited line endings.
 # Prohibited line endings: \r\n
 
-git grep --cached -I -n --no-color -P '\r$' -- ':/' |
+git grep -I -n --no-color -P '\r$' -- ':/' |
 awk '
     BEGIN {
         FS = ":"

.github/check-trailing-whitespace.sh

@@ -1,19 +1,20 @@
 #!/bin/sh
 # Checks for trailing whitespace
 
-git grep --cached -I -n --no-color -P '[ \t]+$' -- ':/' |
+git grep -I -n --no-color -P '[ \t]+$' -- ':/' |
 awk '
     BEGIN {
         FS = ":"
         OFS = ":"
         ret = 0
     }
     {
-        # Only warn for markdown files (*.md) to accomodate text editors
+        # Only warn for markdown files (*.md) to accommodate text editors
         # which do not properly handle trailing whitespace.
         # (e.g. GitHub web editor)
         if ($1 ~ /\.md$/) {
             severity = "WARN"
+            ret = 1
         } else {
             severity = "ERROR"
             ret = 1

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: MarkBind Action
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Build & Deploy MarkBind site
+        uses: MarkBind/markbind-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          rootDirectory: './docs'
+          baseUrl: '/tp' # replace with your repo name
+          version: '^5.1.0'

.github/workflows/gradle.yml

@@ -1,6 +1,14 @@
 name: Java CI
 
-on: [push, pull_request]
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - 'config/**'
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'config/**'
 
 jobs:
   build:
@@ -18,14 +26,9 @@ jobs:
         with:
           ref: master
 
-      - name: Merge to master
+      - name: Checkout triggering commit
         run: git checkout --progress --force ${{ github.sha }}
 
-      - name: Run repository-wide tests
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/.github
-        run: ./run-checks.sh
-
       - name: Validate Gradle Wrapper
         uses: gradle/wrapper-validation-action@v1
 

.github/workflows/shell-checks.yml

@@ -0,0 +1,27 @@
+name: Shell Script Checks
+
+on: [push, pull_request]
+
+
+jobs:
+  run-shell-scripts:
+    strategy:
+      matrix:
+        platform: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@main
+
+      - name: Set up repository
+        uses: actions/checkout@main
+        with:
+          ref: master
+
+      - name: Checkout triggering commit
+        run: git checkout --progress --force ${{ github.sha }}
+
+      - name: Run repository-wide tests
+        working-directory:  ${{ github.workspace }}/.github
+        run: ./run-checks.sh

.gitignore

@@ -18,6 +18,10 @@ hs_err_pid[0-9]*.log
 # Test sandbox files
 src/test/data/sandbox/
 
+# ignore compiled binary files
+/bin/
+
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/

README.md

@@ -1,14 +1,20 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+## Build Status
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-F08-3/tp/graph/badge.svg?token=BJR49ZPCBU)](https://codecov.io/gh/AY2324S1-CS2103T-F08-3/tp)
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-F08-3/tp/actions)
 
-![Ui](docs/images/Ui.png)
+## Overview
+Pawfection is an animal catalog catered towards volunteers in an animal shelter. With Pawfection, we aim to reduce the
+pain points of volunteering at an animal shelter by providing a centralized platform for volunteers to store and retrieve
+information about sheltered animals easily!
 
-* 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.
+  * Ideal for the fast-typist as it is command-line centric.
   * 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.
+  * Comes with detailed documentation for both **users** and **developers**. To learn more, check out [Pawfection's website](https://ay2324s1-cs2103t-f08-3.github.io/tp/index.html)!
+
+## UI
+![Ui](docs/images/Ui.png)
+
+## Credits
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org)
+

build.gradle

@@ -4,6 +4,7 @@ plugins {
     id 'com.github.johnrengelman.shadow' version '7.1.2'
     id 'application'
     id 'jacoco'
+    id "com.adarshr.test-logger" version "3.2.0"
 }
 
 mainClassName = 'seedu.address.Main'
@@ -25,6 +26,18 @@ test {
     finalizedBy jacocoTestReport
 }
 
+testlogger {
+    showPassed false
+    showSkipped false
+    showFailed true
+    showOnlySlow false
+}
+
+
+tasks.withType(JavaExec) {
+    enableAssertions = true
+}
+
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -40,6 +53,11 @@ task coverage(type: JacocoReport) {
     }
 }
 
+task runChecks(type: Exec) {
+    workingDir "${projectDir}/.github"
+    commandLine './run-checks.sh'
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '17.0.7'
@@ -63,10 +81,12 @@ dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    testImplementation "org.mockito:mockito-core:3.+"
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'pawfection.jar'
 }
 
 defaultTasks 'clean', 'test'

codecov.yml

@@ -0,0 +1,2 @@
+codecov:
+  require_ci_to_pass: false

docs/.gitignore

@@ -0,0 +1,23 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+_markbind/logs/
+
+# Dependency directories
+node_modules/
+
+# Production build files (change if you output the build to a different directory)
+_site/
+
+# Env
+.env
+.env.local
+
+# IDE configs
+.vscode/
+.idea/*
+*.iml

docs/AboutUs.md

@@ -1,59 +1,62 @@
 ---
-layout: page
-title: About Us
+  layout: default.md
+  title: "About Us"
 ---
 
+# 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
+### Loysius Lam
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/blizzeracz.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/blizzeracz)]
+[[portfolio](team/blizzeracz.md)]
 
 * Role: Project Advisor
+* Responsibilities: Scheduling and tracking, Deliverables and deadlines
 
-### Jane Doe
+### Jason Baek
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bkjwjason.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/bkjwjason)]
+[[portfolio](team/bkjwjason.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: UI, Java and Integration Expert
 
-### Johnny Doe
+### Chang Xian
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/euchangxian.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/euchangxian)]
+[[portfolio](team/euchangxian.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Testing, Integration expert
 
-### Jean Doe
+### Ja Yee
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/wjayee.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/wjayee)]
+[[portfolio](team/wjayee.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Code quality and Deliverables
 
-### James Doe
+### Jun Neng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/junnengsoo.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/junnengsoo)]
+[[portfolio](team/junnengsoo.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code quality and Documentation

docs/Configuration.md

@@ -1,6 +1,8 @@
 ---
-layout: page
-title: Configuration guide
+  layout: default.md
+  title: "Configuration guide"
 ---
 
+# Configuration guide
+
 Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).

docs/DevOps.md

@@ -1,12 +1,15 @@
 ---
-layout: page
-title: DevOps guide
+  layout: default.md
+  title: "DevOps guide"
+  pageNav: 3
 ---
 
-* Table of Contents
-{:toc}
+# DevOps guide
 
---------------------------------------------------------------------------------------------------------------------
+<!-- * Table of Contents -->
+<page-nav-print />
+
+<!-- -------------------------------------------------------------------------------------------------------------------- -->
 
 ## Build automation