[CS2103T-W12-3] AssetBook

.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@v4
+        with:
+          distribution: 'zulu'
+          java-version: '11'
+      - 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.3.0'

.github/workflows/gradle.yml

@@ -27,11 +27,12 @@ jobs:
         run: ./run-checks.sh
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/wrapper-validation-action@v2
 
       - name: Setup JDK 11
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v4
         with:
+          distribution: 'zulu'
           java-version: '11'
           java-package: jdk+fx
 
@@ -40,6 +41,6 @@ jobs:
 
       - name: Upload coverage reports to Codecov
         if: runner.os == 'Linux'
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

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

README.md

@@ -1,14 +1,17 @@
-[![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/AY2324S2-CS2103T-W12-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-W12-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W12-3/tp/graph/badge.svg?token=ZAZ8O2FN70)](https://codecov.io/gh/AY2324S2-CS2103T-W12-3/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.
+## AssetBook
+
+AssetBook is a specialized application built upon [AddressBook-3](https://github.com/se-edu/addressbook-level3) for logistics and inventory managers to do contact and asset management. 
+It is meant for those who wish to easily retrieve contact details based on contact or asset details.
+
+## Getting Started
+
+Visit the application [website](https://ay2324s2-cs2103t-w12-3.github.io/tp/) for the quick start guide and detailed documentation.
+
+## Acknowledgement
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -66,7 +66,15 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'assetbook.jar'
+}
+
+run {
+    enableAssertions = true
+}
+
+runShadow {
+    enableAssertions = false
 }
 
 defaultTasks 'clean', 'test'

copyright.txt

@@ -1,9 +1,5 @@
 Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob
+AssetBook icon designed using icons from UXWing - https://uxwing.com/
 
-Copyright by Susumu Yoshida - http://www.mcdodesign.com/
-- address_book_32.png
-- AddressApp.ico
-
-Copyright by Jan Jan Kovařík - http://glyphicons.com/
-- calendar.png
-- edit.png
+Copyright by The JetBrains Mono Project Authors - https://github.com/JetBrains/JetBrainsMono
+- JetBrainsMono-SemiBold.ttf

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,66 @@
 ---
-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](http://www.comp.nus.edu.sg).
+# About Us
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
 ## Project team
 
-### John Doe
+### Tang Yetong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/darkvoid32.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](https://darkvoid32.github.io/)]
+[[github](https://github.com/darkvoid32)]
+[[portfolio](team/darkvoid32.md)]
 
-* Role: Project Advisor
+* Roles: UI & UX Expert
+* Responsibilities: Designs and implements frontend for the application, and 
+maintains user documentation.
 
-### Jane Doe
+### Leong Heng Yew
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/aureliony.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/aureliony)]
+[[portfolio](team/aureliony.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Roles: Git & Integration Expert
+* Responsibilities: Defines and assigns technical project tasks. In charge of 
+versioning, maintaining the code, and vets all changes to the code.
 
-### Johnny Doe
+### Yee Jun Hyeok Bryan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bryanyee33.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/bryanyee33)]
+[[portfolio](team/bryanyee33.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Backend Expert
+* Responsibilities: In charge of backend implementation and associated technical
+documentation.
 
-### Jean Doe
+### Muhammad Rizki Bayuaji
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/rizkidelta.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/rizkidelta)]
+[[portfolio](team/rizkidelta.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Roles: UI & UX Expert
+* Responsibilities: Designs and implements frontend for the application, and
+maintains user documentation.
 
-### James Doe
+### Guk Yi Siong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/yisiox.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/yisiox)]
+[[portfolio](team/yisiox.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Taskmaster & QA Expert
+* Responsibilities: In charge of overall coordination, tracking deadlines and 
+deliverables, testing of code, and ensuring code and documentation quality.

docs/Configuration.md

@@ -1,6 +1,8 @@
 ---
-layout: page
-title: Configuration guide
+  layout: default.md
+  title: "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`).
+# 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