[CS2103-T13-2] CampusConnect

.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'
+          version: '^5.1.0'

.github/workflows/gradle.yml

@@ -22,7 +22,7 @@ jobs:
         run: git checkout --progress --force ${{ github.sha }}
 
       - name: Run repository-wide tests
-        if: runner.os == 'Linux'
+        if: runner.os == 'macOS'
         working-directory:  ${{ github.workspace }}/.github
         run: ./run-checks.sh
 
@@ -39,7 +39,7 @@ jobs:
         run: ./gradlew check coverage
 
       - name: Upload coverage reports to Codecov
-        if: runner.os == 'Linux'
+        if: runner.os == 'macOS'
         uses: codecov/codecov-action@v3
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -21,3 +21,6 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+bin

README.md

@@ -1,14 +1,30 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# CampusConnect
+
+[![Java CI Status](https://github.com/AY2324S1-CS2103T-T13-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T13-2/tp/actions/workflows/gradle.yml)
+[![Markbind CI Status](https://github.com/AY2324S1-CS2103T-T13-2/tp/workflows/MarkBind%20Action/badge.svg)](https://github.com/AY2324S1-CS2103T-T13-2/tp/actions/workflows/docs.yml)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-T13-2/tp/graph/badge.svg?token=V0VMEEZQIF)](https://codecov.io/gh/AY2324S1-CS2103T-T13-2/tp)
 
 ![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.
+
+## Overview
+
+**CampusConnect** is an address book specifically catered for students living on NUS campus.
+With CampusConnect, you can stay organised, stay connected, and make your on-campus experience at NUS stress-free!
+
+**CampusConnect** is:
+* written in Java, in OOP fashion.
+* a desktop application that uses command-line interface (CLI) with fast, easy-to-use commands which make it ideal for the
+  fast typist.
+* documented for both users and developers. For the detailed documentation of this project, see the **[CampusConnect Product Website](https://ay2324s1-cs2103t-t13-2.github.io/tp/)**.
+* optimised for CLI.
+* a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
+
+## Features
+1. Keep track of various details of fellow campus residents
+2. Receive reminders for fellow campus residents' birthdays
+3. Mark specific contacts as emergency contacts
+4. Search for fellow campus residents using expressive filters
+
+## Acknowledgements
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -20,7 +20,16 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
+    doFirst {
+        if (System.getProperty("os.name").equals("Linux")) {
+            exclude '**/ui/**'
+        }
+    }
     useJUnitPlatform()
     finalizedBy jacocoTestReport
 }
@@ -59,14 +68,18 @@ dependencies {
 
     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 group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jdk8', version: '2.7.4'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    testImplementation 'org.testfx:testfx-core:4.0.16-alpha'
+    testImplementation 'org.testfx:testfx-junit5:4.0.16-alpha'
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'CampusConnect.jar'
 }
 
 defaultTasks 'clean', 'test'

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,57 @@
 ---
-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
+### Calvin Fong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lordidiot.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/lordidiot)]
+[[portfolio](team/lordidiot.md)]
 
-* Role: Project Advisor
+- Role: Team lead, Scheduling and tracking
 
-### Jane Doe
+### Wong Kok Rui
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/kokrui.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/kokrui)]
+[[portfolio](team/kokrui.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+- Role: Code quality, Integration
 
-### Johnny Doe
+### Nguyen Phu Hao
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/vn-hao.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/vn-hao)]
+[[portfolio](team/vn-hao.md)]
 
-* Role: Developer
-* Responsibilities: Data
+- Role: Testing
 
-### Jean Doe
+### Lim Jun Xian
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/limjunxian1.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/limjunxian1)]
+[[portfolio](team/limjunxian1.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+- Role: Deliverables and deadlines
 
-### James Doe
+### Conrad Soon
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/conradsoon.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/conradsoon)]
+[[portfolio](team/conradsoon.md)]
 
-* Role: Developer
-* Responsibilities: UI
+- Role: 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