nus-cs2103-AY2425S2 · Ben926 · Mar 25, 2025 · Mar 25, 2025 · Mar 25, 2025 · Mar 25, 2025
diff --git a/.github/workflows/docs.yml b/.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'
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,6 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+bin
diff --git a/README.md b/README.md
@@ -1,14 +1,131 @@
-[![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/AY2425S2-CS2103T-T08-2/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S2-CS2103T-T08-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.
+## Welcome to the KrustyKrab
+
+_For all restaurant staff folks who struggle with keeping track of who's coming to eat._
+
+This is a **CLI-based bookings tracker** which helps in keeping track of booking details and customer information in a simple, efficient, and centralized system for quick and easy management.
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+## How does it help?
+
+> If you're wasting time, you're wasting money... and that's just sick.
+>
+> ~ Mr Krabs
+
+KrustyKrab provides restaurant staff with a centralised platform that allows them to keep track of both customers and their bookings, with an easy command-based interface to allow staff to:
+
+Customer Commands
+- Add customers
+- Edit customers
+- Delete customers
+- Find customers by keyword
+- List all customers
+- Clear all customers
+
+Booking Commands
+- Add bookings
+- Edit bookings
+- Delete bookings
+- Clear all completed/cancelled bookings
+- Filter bookings by phone number/date/booking status
+- Mark bookings as completed/cancelled/upcoming
+- Display all bookings
+- Display all upcoming bookings
+- Summarise bookings of the day
+
+## Getting started
+
+### Download our Jar file
+
+You can find our Jar file under [Releases](https://github.com/AY2425S2-CS2103T-T08-2/tp/releases). Download the latest one and test it out!
+
+### Forking the Repo
+
+1. Navigate to the repository on GitHub: [AY2425S2-CS2103T-T08-2/tp](https://github.com/AY2425S2-CS2103T-T08-2/tp).
+2. Click on the "Fork" button at the top right corner of the page to create a copy of the repository under your own GitHub account.
+3. Clone the forked repository to your local machine using the following command:
+
+```sh
+git clone https://github.com/YOUR_USERNAME/tp.git
+```
+
+4. Navigate into the project directory:
+
+```sh
+cd tp
+```
+
+5. Set up the upstream remote to keep your fork in sync with the original repository:
+
+```sh
+git remote add upstream https://github.com/AY2425S2-CS2103T-T08-2/tp.git
+```
+
+### Building the Project
+
+1. Ensure you have Java 17 or above installed on your machine.
+2. Open a terminal and navigate to the project directory.
+3. Build the project using Gradle:
+
+```sh
+./gradlew build
+```
+
+4. Run the application:
+
+```sh
+./gradlew run
+```
+
+### Running Tests
+
+1. To run all tests, use the following command:
+
+```sh
+./gradlew test
+```
+
+### Additional Setup
+
+For more detailed setup instructions, refer to the [Developer Guide](https://ay2425s2-cs2103t-t08-2.github.io/tp/DeveloperGuide.html).
+
+## Getting help with KrustyKrab
+
+> W-well, I uh... oh barnacles...
+>
+> ~ Mr Krabs
+
+Feel free to check out our [website](https://ay2425s2-cs2103t-t08-2.github.io/tp/) to clarify any issues you may have.
+
+In the event that that's not enough, feel free to reach out to our development team!
+
+## The Dev Team
+
+### [Jaylon Tan](https://github.com/jaylontan)
+
+**Data Developer**  
+Avid Spongebob lover
+
+### [Benjamin Koh](https://github.com/ben926)
+
+**Team Lead**  
+Would like everyone to know he created [Gyatword.com](https://gyatword.com)
+
+### [Lu "Bloin" Bolin](https://github.com/LuBolin)
+
+**Team Lead**  
+Has been coding since 2 years old
+
+### [Wang Yanxiang](https://github.com/isawangyx)
+
+**Code Quality Connoisseur**  
+Here for diversity
+
+### [Patrick Thomas](https://github.com/pastchum)
+
+**UI/UX Undertaker**  
+Does not live under a rock in bikini bottom
diff --git a/_markbind/logs/.4a27e4dd4d52b0b210ca13b42ac22c488093fce8-audit.json b/_markbind/logs/.4a27e4dd4d52b0b210ca13b42ac22c488093fce8-audit.json
@@ -0,0 +1,14 @@
+{
+    "keep": {
+        "days": false,
+        "amount": 5
+    },
+    "auditLog": "_markbind/logs/.4a27e4dd4d52b0b210ca13b42ac22c488093fce8-audit.json",
+    "files": [
+        {
+            "date": 1740280041553,
+            "name": "_markbind/logs/markbind-2025-02-23.log",
+            "hash": "3cf652ee06f16027bf4d8da1cd521409"
+        }
+    ]
+}
diff --git a/_markbind/logs/markbind-2025-02-23.log b/_markbind/logs/markbind-2025-02-23.log
@@ -0,0 +1,19 @@
+2025-02-23T03:07:21.547Z - error: No config file found in parent directories of /Users/ben/Documents/IdeaProjects/tp
+2025-02-23T03:07:21.552Z - error: uncaughtException: The "path" argument must be of type string. Received undefined date=Sun Feb 23 2025 11:07:21 GMT+0800 (Singapore Standard Time), pid=59235, uid=501, gid=20, cwd=/Users/ben/Documents/IdeaProjects/tp, execPath=/opt/homebrew/Cellar/node/23.6.0/bin/node, version=v23.6.0, argv=[/opt/homebrew/Cellar/node/23.6.0/bin/node, /opt/homebrew/bin/markbind, serve], rss=212172800, heapTotal=103251968, heapUsed=35438360, external=2322305, arrayBuffers=16875, loadavg=[4.53271484375, 4.5048828125, 4.4638671875], uptime=9197823
+TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
+    at Object.join (node:path:1245:7)
+    at serve (/opt/homebrew/lib/node_modules/markbind-cli/src/cmd/serve.js:57:27)
+    at Command.<anonymous> (/opt/homebrew/lib/node_modules/markbind-cli/index.js:62:5)
+    at Command.listener [as _actionHandler] (/opt/homebrew/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:488:17)
+    at /opt/homebrew/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:65
+    at Command._chainOrCall (/opt/homebrew/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1144:12)
+    at Command._parseCommand (/opt/homebrew/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:27)
+    at Command._dispatchSubcommand (/opt/homebrew/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1050:25)
+    at Command._parseCommand (/opt/homebrew/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1193:19)
+    at Command.parse (/opt/homebrew/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:897:10)
+    at Object.<anonymous> (/opt/homebrew/lib/node_modules/markbind-cli/index.js:87:9)
+    at Module._compile (node:internal/modules/cjs/loader:1739:14)
+    at Object..js (node:internal/modules/cjs/loader:1904:10)
+    at Module.load (node:internal/modules/cjs/loader:1473:32)
+    at Function._load (node:internal/modules/cjs/loader:1285:12)
+    at TracingChannel.traceSync (node:diagnostics_channel:322:14)
diff --git a/build.gradle b/build.gradle
@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'krustykrab.jar'
 }
 
 defaultTasks 'clean', 'test'
+
+run {
+    enableAssertions = true
+}
diff --git a/docs/.gitignore b/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
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -1,59 +1,62 @@
 ---
-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
+### Jaylon Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/jaylontan.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/jaylontan)]
+[[portfolio](team/jaylontan.md)]
 
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Data
 
-### Jane Doe
+### Lu Bolin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lubolin.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/lubolin)]
+[[portfolio](team/lubolin.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+- Role: Team Lead
+- Responsibilities: UI
 
-### Johnny Doe
+### Patrick Thomas
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pastchum.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/pastchum)]
+[[portfolio](team/patrickthomas.md)]
 
-* Role: Developer
-* Responsibilities: Data
+- Role: Developer
+- Responsibilities: UI/UX
 
-### Jean Doe
+### Benjamin Koh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ben926.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ben926)]
+[[portfolio](team/benjaminkoh.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Team Lead
+* Responsibilities: Overall project coordination
 
-### James Doe
+### Wang Yanxiang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/isawangyx.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/isawangyx)]
+[[portfolio](team/wangyanxiang.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Code Quality
+* Responsibilities: Looks after code quality, ensures adherence to coding standards
diff --git a/docs/Configuration.md b/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`).
diff --git a/docs/DevOps.md b/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
 
@@ -75,5 +78,5 @@ 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. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`).
-1. Tag the repo with the version number. e.g. `v0.1`
+1. Tag the repo with the version number. e.g. `v1.5`
 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.