[CS2103T-W09-4] JABPro

.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,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/

README.md

@@ -1,14 +1,52 @@
-[![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.
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-W09-4/tp/actions)
+
+# JABPro
+![ui image](https://raw.githubusercontent.com/ScarletBlanks/tp/master/docs/images/Ui.png)
+
+# Table of Contents
+
+## Features
+
+Search Job Applicants
+
+Add Contact Information
+
+Add Optional Comments
+
+List All Candidate Information
+
+Delete an Entry
+
+Set Applicant Status
+
+Add GitHub/LinkedIn Username for a Candidate
+
+Open User LinkedIn or Github Account
+
+### Applicant Management
+
+JABPro allows you to efficiently search and manage job applicants based on various criteria. You can search for applicants by name, email, phone number, and status. Additionally, you can combine multiple search categories to narrow down your results.
+
+### Command Types
+
+Search Job Applicants : Use Search categories to narrow down results
+
+Add Contact Information : You can add contact information for job applicants, including their name, email, and phone number. This feature helps you keep track of applicant details.
+
+Add Optional Comments : allows you to add optional comments or notes to a candidate's profile. These comments can be tagged with the candidate's details and provide additional information or insights about the applicant.
+
+List All Candidate Information : You can retrieve a comprehensive list of all job applicants and their relevant information, such as name, email, and phone number. This feature makes it easy to review and manage candidate profiles.
+
+Delete an Entry : If needed, you can remove a candidate's profile from the system. This feature helps you maintain an up-to-date database of applicants
+
+Set Applicant Status : You can set the application status for each candidate, including options like "Preliminary," "Interviewed," "Rejected," and "Offered." This feature helps you track the progress of each applicant.
+
+Add Github/LinkedIn Username for a Candidate : JASMS allows you to add the candidate's social profile usernames (Github or LinkedIn) to their existing contact details. This feature helps you link to their online profiles for further evaluation.
+
+Open User LinkedIn or Github Account : You can quickly access a candidate's LinkedIn or Github profile directly from JABPro. This feature provides easy access to additional information about the applicant.
+
+Visit our website for more details!
+(https://github.com/AY2324S1-CS2103T-W09-4/tp)
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+

build.gradle

@@ -65,8 +65,12 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
 }
 
+run {
+    enableAssertions = true
+}
+
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'jabpro.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,70 @@
 ---
-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 `e0958427[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Sean Koh Hak Guan
+
+<img src="images/sk2001git.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[github](https://github.com/sk2001git)]
+[[portfolio](team/sk2001git.md)]
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+* Role: Developer
+* Responsibilities: Deliverables & Deadlines, Integration
+* In charge of: Storage
 
-* Role: Project Advisor
 
-### Jane Doe
+### Ariella Thirza Callista
 
-<img src="images/johndoe.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/ariellacallista.png" width="200px">
+
+[[github](http://github.com/AriellaCallista)]
+[[portfolio](team/ariellacallista.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: Documentation
+* In charge of: Model, UI
 
-### Johnny Doe
+### Misra Aditya
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/madlamprey.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/MadLamprey)]
+[[portfolio](team/madlamprey.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Testing
+* In charge of: Test cases and coverage
+
 
-### Jean Doe
+### Catherine Liang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ketweeen.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ketweeen)]
+[[portfolio](team/ketweeen.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Scheduling and tracking
+* In charge of: Commons
 
-### James Doe
+### Goh Peng Tat
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/scarletblanks.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ScarletBlanks)]
+[[portfolio](team/scarletblanks.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Code Quality
+* In charge of: Logic

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