[CS2103T-F12-2] EasyWeds

.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: '17'
+          distribution: 'zulu'
+      - name: Build & Deploy MarkBind site
+        uses: MarkBind/markbind-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          rootDirectory: './docs'
+          baseUrl: '/tp' # assuming your repo name is tp
+          version: '^5.5.2'

.gitignore

@@ -7,6 +7,8 @@ src/main/resources/docs/
 /.idea/
 /out/
 /*.iml
+/bin/
+/.vscode/
 
 # Storage/log files
 /data/
@@ -21,3 +23,7 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+# Node.js
+node_modules/

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "interactive"
+}

README.md

@@ -1,14 +1,10 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![Build Status](https://github.com/AY2425S2-CS2103T-F12-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S2-CS2103T-F12-2/tp/actions)
 
 ![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/#contributing-to-se-edu) for more info.
+- **EasyWeds** is developed as part of NUS CS2103T Module Project
+- EasyWeds is a desktop application for streamlining wedding planning by centralising vendor and client information, ensuring planners can quickly access contacts, track event schedules, and manage multiple weddings efficiently.
+  - It is **written in OOP fashion**. It provides a **well-written** code base (around 9 KLoC).
+  - It comes with a **high level of user and developer documentation**.
+- For the detailed documentation of this project, see the **[EasyWeds Product Website](https://ay2425s2-cs2103t-f12-2.github.io/tp)**.
+- This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -20,6 +20,10 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+run {
+    enableAssertions = true
+}
+
 test {
     useJUnitPlatform()
     finalizedBy jacocoTestReport
@@ -61,12 +65,15 @@ dependencies {
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
 
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
+    testImplementation 'org.testfx:testfx-core:4.0.16-alpha'
+    testImplementation 'org.testfx:testfx-junit5:4.0.16-alpha'
+    testImplementation 'org.testfx:openjfx-monocle:jdk-12.0.1+2'
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'easyweds.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,61 @@
 ---
-layout: page
-title: About Us
+layout: default.md
+title: "About Us"
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg).
+# 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
+### Geng Yudong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/gengyudong.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/gengyudong)]
+[[Portfolio](team/gengyudong.md)]
 
-* Role: Project Advisor
+* Role: Developer (Team Lead)
+* Responsibilities: Feature - Delete Contacts
 
-### Jane Doe
+### Glenn Liew Zi Yi
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/glennliew.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/glennliew)]
+[[Portfolio](team/glennliew.md)]
 
-* Role: Team Lead
+* Role: Developer (Documentation)
 * Responsibilities: UI
 
-### Johnny Doe
+### Hu Junjie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/grassheadd.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[Github](http://github.com/grassheadd)] [[Portfolio](team/junjie.md)]
 
-* Role: Developer
+* Role: Developer (Code Quality)
 * Responsibilities: Data
 
-### Jean Doe
+### Arulanandam James Beryl
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jamesberyl.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](https://github.com/jamesberyl)]
+[[Portfolio](team/jamesberyl.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer (Testing)
+* Responsibilities: Feature - Filter Contacts
 
-### James Doe
+### Wei Yan Min Oo
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/weiyanminoo.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[Github](http://github.com/weiyanminoo)]
+[[Portfolio](team/weiyanminoo.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer (Integration)
+* Responsibilities: Feature - Add Contacts

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