CS2103T-F14-3 RecruitIntel

README.md

@@ -1,14 +1,84 @@
-[![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-F14-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S2-CS2103T-F14-3/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.
+# RecruitIntel
+
+## Overview
+
+RecruitIntel is a **desktop application designed specifically for Apple's HR recruiters** to efficiently manage candidate information. While offering an easy-to-use visual interface, it features powerful text commands that help process candidate information considerably faster than traditional mouse-based applications.
+
+## Features
+
+* **Candidate Management**
+    * Add candidates with detailed information
+    * Edit existing candidate records
+    * Delete candidate records
+    * List all candidates in the system
+
+* **Advanced Categorization**
+    * Classify candidates by skills, teams, and positions
+    * Tag candidates with relevant skills and attributes
+    * Find candidates by name with partial matching
+
+* **Interview Management**
+    * Schedule interviews with specific times and durations
+    * Sort candidates by interview times
+    * Add detailed notes about interview performance
+
+* **User Experience**
+    * Data is automatically saved
+    * Fast command-based interface
+    * Undo/redo functionality for most operations
+
+## Quick Start
+
+1. Ensure you have Java `17` or above installed.
+2. Download the latest `RecruitIntel.jar` from the [releases page](https://github.com/AY2425S2-CS2103T-F14-3/tp/releases).
+3. Create a dedicated folder for RecruitIntel.
+4. Copy the downloaded JAR file into this folder.
+5. Run the application:
+   ```
+   java -jar recruitintel.jar
+   ```
+
+## Command Examples
+
+* **Adding a candidate**:
+  ```
+  add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 j/Software Engineer tm/IOS Development t/Swift
+  ```
+
+* **Scheduling an interview**:
+  ```
+  interview 1 2025-04-01 10:00 40
+  ```
+
+# Installation
+## Prerequisites
+
+Java (JDK 17 zulu version)
+Gradle
+
+## Steps
+
+### Clone the Repository
+
+```
+git clone https://github.com/AY2425S2-CS2103T-F14-3/tp.git
+cd tp
+```
+### Build the Project
+
+```
+gradle build        # Using Gradle
+```
+
+### Run the Application
+```
+java -jar RecruitIntel.jar   # Running the JAR
+```
+
+# Acknowledgements
+This project is based on the AddressBook-Level3 project created by
+the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -16,6 +16,10 @@ repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
 }
 
+run {
+    enableAssertions = true
+}
+
 checkstyle {
     toolVersion = '10.2'
 }
@@ -66,7 +70,7 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'RecruitIntel.jar'
 }
 
 defaultTasks 'clean', 'test'

docs/AboutUs.md

@@ -5,55 +5,47 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](https://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 `e1300530@u.nus.edu`
 
 ## Project team
 
-### John Doe
+### Huang Zekai
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hzk-lab.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Project Advisor
-
-### Jane Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[homepage](https://www.linkedin.com/in/zekai-huang-23213b28b)]
+[[github](https://github.com/hzk-lab)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Scheduling and tracking, including defining, assigning, and tracking project tasks.
+* Responsibilities: Data Structure + Threading
 
-### Johnny Doe
+### Benedict Bryan Tjandra
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/bryantjandra.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/bryantjandra)]
+[[portfolio](team/bryantjandra.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: UI + Code Quality
+
 
-### Jean Doe
+### GONG HAOZHEN
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/lsmnbmnc.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](https://github.com/LsmnBmnc)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Develop new features
 
-### James Doe
+### Li Daoxin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/prog-neuro-com.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/Prog-Neuro-Com)]
+[[portfolio](team/prog-neuro-com)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Dev Ops + Threading