[CS2103T-W11-1] HRMate

.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

@@ -2,6 +2,7 @@
 /.gradle/
 /build/
 src/main/resources/docs/
+/bin/
 
 # IDEA files
 /.idea/
@@ -21,3 +22,10 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/
+
+.classpath
+.project
+.settings/
+
+export/

README.md

@@ -1,14 +1,18 @@
-[![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/AY2324S1-CS2103T-W11-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-W11-1/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#https://se-education.org/#contributing) for more info.
+## HRMate
+
+HRMate is a **desktop address book application** that aims to streamline HR processes, by offering an intuitive, CLI-based contact management system with specialised functionalities for HR tasks.
+
+* Besides normal address book function, HRMate allows HR managers to:
+  * Managing people by tags
+  * Importing/Exporting their own csv files
+
+### Resources
+* **User Guide** for HRMate can be found here: [User Guide](https://github.com/AY2324S1-CS2103T-W11-1/tp/blob/master/docs/UserGuide.md).
+* **Developer Guide** for HRMate can be found here: [Developer Guide](https://github.com/AY2324S1-CS2103T-W11-1/tp/blob/master/docs/DeveloperGuide.md).
+* Information of contributors for HRMate can be found here:[Team Inforation](https://github.com/AY2324S1-CS2103T-W11-1/tp/blob/master/docs/AboutUs.md).
+### 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,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'hrmate.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,65 @@
 ---
-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`
+You can reach us at the email
+ - `mary84060117[at]gmail.com`
+ - `tan.yuhao.ivan[at]gmail.com`
+ - `weihong.ong[at]u.nus.edu.sg`
+ - `nancyqinilm[at]gmail.com`
+ - `ryanozx[at]u.nus.edu.sg`
 
 ## Project team
 
-### John Doe
-
-<img src="images/johndoe.png" width="200px">
+### Chen Qun
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/jean-cq.png" width="200px">
 
-* Role: Project Advisor
+[[github](https://github.com/jean-cq)]
+[[portfolio](team/jean-cq.md)]
 
-### Jane Doe
+* Role: Developer, Deliverables and deadlines
+* Responsibilities: Ensure project deliverables are done on time and in the right format.
+### Ivan Tan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ivyy-poison.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ivyy-poison)]
+[[portfolio](team/ivyy-poison.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer, Integration
+* Responsibilities: In charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole.
 
-### Johnny Doe
+### Ong Wei Hong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ong-wei-hong.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ong-wei-hong)] [[portfolio](team/ong-wei-hong.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Developer, Code Quality
+* Responsibilities: Looks after code quality, ensures adherence to coding standards, etc.
 
-### Jean Doe
+### Qin Nanxin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/infibeyond.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/infibeyond)]
+[[portfolio](team/infibeyond.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer, Documentation
+* Responsibilities: Ensures the quality of various project documents.
 
-### James Doe
+### Ryan Ong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ryanozx.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ryanozx)]
+[[portfolio](team/ryanozx.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer, Testing
+* Responsibilities: Ensures the testing of the project is done properly and on time.

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