[CS2103T-W10-2] SEPlendid

.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'

.gitignore

@@ -21,3 +21,10 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+
+/node_modules/
+
+# Coverage report files
+/htmlReport/

README.md

@@ -1,14 +1,27 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/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#https://se-education.org/#contributing) for more info.
+# SEPlendid
+> Your Ultimate SEP Planning tool
+
+![Ui](docs/images/MappingListUi.png)
+
+**SEPlendid is a desktop application for researching on your modules mapping, helping you plan for your upcoming
+Student Exchange Programme (SEP).** While it
+has a GUI, most of the
+user
+interactions happen using a CLI (Command Line Interface).
+
+* If you are interested in using SEPlendid, head over to the [_Quick Start_ section of the **User Guide**](https://ay2324s1-cs2103t-w10-2.github.io/tp/UserGuide.html).
+* If you are interested about contributing to SEPlendid, the [**Developer Guide**](https://ay2324s1-cs2103t-w10-2.github.io/tp/DeveloperGuide.html) is a good
+  place to start.
+
+
+**Acknowledgements**
+
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+
+**CI and Codecov status**
+> [![Java CI](https://github.com/AY2324S1-CS2103T-W10-2/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S1-CS2103T-W10-2/tp/actions/workflows/gradle.yml)
+[![MarkBind Action](https://github.com/AY2324S1-CS2103T-W10-2/tp/actions/workflows/docs.yml/badge.svg)](https://github.com/AY2324S1-CS2103T-W10-2/tp/actions/workflows/docs.yml)
+[![pages-build-deployment](https://github.com/AY2324S1-CS2103T-W10-2/tp/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/AY2324S1-CS2103T-W10-2/tp/actions/workflows/pages/pages-build-deployment)
+[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W10-2/tp/graph/badge.svg?token=6GEPWNR01R)](https://codecov.io/gh/AY2324S1-CS2103T-W10-2/tp)
+
+

_markbind/logs/.4a27e4dd4d52b0b210ca13b42ac22c488093fce8-audit.json

@@ -0,0 +1,19 @@
+{
+    "keep": {
+        "days": false,
+        "amount": 5
+    },
+    "auditLog": "_markbind/logs/.4a27e4dd4d52b0b210ca13b42ac22c488093fce8-audit.json",
+    "files": [
+        {
+            "date": 1699256948020,
+            "name": "_markbind/logs/markbind-2023-11-06.log",
+            "hash": "3bbffa11d6d4beff9162d4c44517525c"
+        },
+        {
+            "date": 1699364655497,
+            "name": "_markbind/logs/markbind-2023-11-07.log",
+            "hash": "4aff874dd97d27c0325ffed5198e7da2"
+        }
+    ]
+}

_markbind/logs/markbind-2023-11-06.log

@@ -0,0 +1,57 @@
+2023-11-06T07:49:08.016Z - error: No config file found in parent directories of /Users/alyssaong/tp
+2023-11-06T07:49:08.020Z - error: uncaughtException: The "path" argument must be of type string. Received undefined date=Mon Nov 06 2023 15:49:08 GMT+0800 (Singapore Standard Time), pid=4678, uid=501, gid=20, cwd=/Users/alyssaong/tp, execPath=/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, version=v16.20.0, argv=[/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, /Users/alyssaong/.nvm/versions/node/v16.20.0/bin/markbind, serve], rss=108003328, heapTotal=64487424, heapUsed=38989432, external=9341104, arrayBuffers=657076, loadavg=[1.7001953125, 1.8681640625, 1.73291015625], uptime=14148
+TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
+    at new NodeError (node:internal/errors:387:5)
+    at validateString (node:internal/validators:162:11)
+    at Object.join (node:path:1172:7)
+    at serve (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/src/cmd/serve.js:39:27)
+    at Command.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:61:5)
+    at Command.listener [as _actionHandler] (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:488:17)
+    at /Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:65
+    at Command._chainOrCall (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1144:12)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:27)
+    at Command._dispatchSubcommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1050:25)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1193:19)
+    at Command.parse (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:897:10)
+    at Object.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:86:9)
+    at Module._compile (node:internal/modules/cjs/loader:1196:14)
+    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1250:10)
+    at Module.load (node:internal/modules/cjs/loader:1074:32)
+2023-11-06T07:49:46.880Z - error: No config file found in parent directories of /Users/alyssaong/tp
+2023-11-06T07:49:46.885Z - error: uncaughtException: The "path" argument must be of type string. Received undefined date=Mon Nov 06 2023 15:49:46 GMT+0800 (Singapore Standard Time), pid=4690, uid=501, gid=20, cwd=/Users/alyssaong/tp, execPath=/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, version=v16.20.0, argv=[/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, /Users/alyssaong/.nvm/versions/node/v16.20.0/bin/markbind, serve], rss=107626496, heapTotal=64487424, heapUsed=39347152, external=9341104, arrayBuffers=718255, loadavg=[1.7724609375, 1.853515625, 1.73291015625], uptime=14186
+TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
+    at new NodeError (node:internal/errors:387:5)
+    at validateString (node:internal/validators:162:11)
+    at Object.join (node:path:1172:7)
+    at serve (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/src/cmd/serve.js:39:27)
+    at Command.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:61:5)
+    at Command.listener [as _actionHandler] (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:488:17)
+    at /Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:65
+    at Command._chainOrCall (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1144:12)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:27)
+    at Command._dispatchSubcommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1050:25)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1193:19)
+    at Command.parse (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:897:10)
+    at Object.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:86:9)
+    at Module._compile (node:internal/modules/cjs/loader:1196:14)
+    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1250:10)
+    at Module.load (node:internal/modules/cjs/loader:1074:32)
+2023-11-06T07:50:34.870Z - error: No config file found in parent directories of /Users/alyssaong/tp
+2023-11-06T07:50:34.873Z - error: uncaughtException: The "path" argument must be of type string. Received undefined date=Mon Nov 06 2023 15:50:34 GMT+0800 (Singapore Standard Time), pid=4708, uid=501, gid=20, cwd=/Users/alyssaong/tp, execPath=/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, version=v16.20.0, argv=[/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, /Users/alyssaong/.nvm/versions/node/v16.20.0/bin/markbind, s], rss=109035520, heapTotal=64225280, heapUsed=39189792, external=9341104, arrayBuffers=701828, loadavg=[1.69873046875, 1.83740234375, 1.73291015625], uptime=14234
+TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
+    at new NodeError (node:internal/errors:387:5)
+    at validateString (node:internal/validators:162:11)
+    at Object.join (node:path:1172:7)
+    at serve (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/src/cmd/serve.js:39:27)
+    at Command.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:61:5)
+    at Command.listener [as _actionHandler] (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:488:17)
+    at /Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:65
+    at Command._chainOrCall (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1144:12)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:27)
+    at Command._dispatchSubcommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1050:25)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1193:19)
+    at Command.parse (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:897:10)
+    at Object.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:86:9)
+    at Module._compile (node:internal/modules/cjs/loader:1196:14)
+    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1250:10)
+    at Module.load (node:internal/modules/cjs/loader:1074:32)

_markbind/logs/markbind-2023-11-07.log

@@ -0,0 +1,19 @@
+2023-11-07T13:44:15.473Z - error: No config file found in parent directories of /Users/alyssaong/tp
+2023-11-07T13:44:15.496Z - error: uncaughtException: The "path" argument must be of type string. Received undefined date=Tue Nov 07 2023 21:44:15 GMT+0800 (Singapore Standard Time), pid=15974, uid=501, gid=20, cwd=/Users/alyssaong/tp, execPath=/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, version=v16.20.0, argv=[/Users/alyssaong/.nvm/versions/node/v16.20.0/bin/node, /Users/alyssaong/.nvm/versions/node/v16.20.0/bin/markbind, s], rss=108118016, heapTotal=64225280, heapUsed=39219960, external=9341104, arrayBuffers=463625, loadavg=[2.4072265625, 2.37548828125, 2.11865234375], uptime=121855
+TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
+    at new NodeError (node:internal/errors:387:5)
+    at validateString (node:internal/validators:162:11)
+    at Object.join (node:path:1172:7)
+    at serve (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/src/cmd/serve.js:39:27)
+    at Command.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:61:5)
+    at Command.listener [as _actionHandler] (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:488:17)
+    at /Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:65
+    at Command._chainOrCall (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1144:12)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1227:27)
+    at Command._dispatchSubcommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1050:25)
+    at Command._parseCommand (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:1193:19)
+    at Command.parse (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/node_modules/commander/lib/command.js:897:10)
+    at Object.<anonymous> (/Users/alyssaong/.nvm/versions/node/v16.20.0/lib/node_modules/markbind-cli/index.js:86:9)
+    at Module._compile (node:internal/modules/cjs/loader:1196:14)
+    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1250:10)
+    at Module.load (node:internal/modules/cjs/loader:1074:32)

build.gradle

@@ -41,6 +41,7 @@ task coverage(type: JacocoReport) {
 }
 
 dependencies {
+    testImplementation 'junit:junit:4.13.1'
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '17.0.7'
 
@@ -66,7 +67,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'SEPlendid.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 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,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
+### Lam Cheng Hou
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lamchenghou.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/lamchenghou)]
+[[portfolio](team/lamchenghou.md)]
 
-* Role: Project Advisor
+* Role: Team Lead
+* Responsibilities: Deliverables and Deadlines, Mapping, Parsing
 
-### Jane Doe
+### Yim Sohyun
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/dlathyun.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/dlathyun)]
+[[portfolio](team/dlathyun.md)]
 
-* Role: Team Lead
+* Role: Developer
 * Responsibilities: UI
 
-### Johnny Doe
+### Alyssa Ong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/alyssaongyx.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/alyssaongyx)]
+[[portfolio](team/alyssaongyx.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI, Code Quality
 
-### Jean Doe
+### Alicia Michelle Wang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/aliciamichellew.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/aliciamichellew)]
+[[portfolio](team/aliciamichellew.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Command + Errors
 
-### James Doe
+### Tan Jing Sheng
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tjingsheng.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tjingsheng)]
+[[portfolio](team/tjingsheng.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Storage, Ui, Testing

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