From 03ae46d194ca89134fe31c068dee454caf727af3 Mon Sep 17 00:00:00 2001 From: logical-1985516 Date: Wed, 28 Feb 2024 23:07:34 +0800 Subject: [PATCH 1/3] Update README to match project --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5a6e324159f..6e044111ed5 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,15 @@ [![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W08-1/tp/graph/badge.svg?token=IG2LRI4TTR)](https://codecov.io/gh/AY2324S2-CS2103T-W08-1/tp) ![Ui](docs/images/Ui.png) -* This is **a sample project for Software Engineering (SE) students**.
+* This is **an app for recruiters to manage candidates**.
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. + * retrieves the candidate list if an excel sheet containing the candidate list is put in the correct location + * create/read/update/delete candidates in the candidate list + * track the status of each candidate in the hiring pipeline +* The project is an ongoing software project for a desktop application (called _HireHub_) used for managing candidate details. + * It is based on the AddressBook-Level3 project, with additional tweaks and features to provide a customised experience for recruiters. + * From the AddressBook-Level3 project: > It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** 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. +* It is named `Hirehub` because it is meant to help recruiters to manage and hire candidates seamlessly. +* For the detailed documentation of this project, see the **[User Guide](https://github.com/AY2324S2-CS2103T-W08-1/tp/blob/master/docs/UserGuide.md)** if you are interested in using HireHub, or the **[Developer Guide](https://github.com/AY2324S2-CS2103T-W08-1/tp/blob/master/docs/DeveloperGuide.md)** if you are interested in developing HireHub. +* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). From 1142f1081e52119f39fc6d17047d52718525fbc1 Mon Sep 17 00:00:00 2001 From: logical-1985516 Date: Wed, 28 Feb 2024 23:19:58 +0800 Subject: [PATCH 2/3] Update AboutUs (Yan Jie) --- docs/AboutUs.md | 10 +++---- docs/images/logical-1985516.png | Bin 0 -> 1961 bytes docs/team/yanjie.md | 46 ++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 5 deletions(-) create mode 100644 docs/images/logical-1985516.png create mode 100644 docs/team/yanjie.md diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 79cce0418bb..1eb4dc8ee01 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -29,15 +29,15 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` * Role: Developer * Responsibilities: Frontend, Backend, DevOps, Code Reviews -### Jane Doe +### Yan Jie -[[github](http://github.com/johndoe)] -[[portfolio](team/johndoe.md)] +[[github](http://github.com/logical-1985516)] +[[portfolio](team/yanjie.md)] -* Role: Team Lead -* Responsibilities: UI +* Role: Developer +* Responsibilities: Frontend, Documentation, Code Reviews ### Ikhoon Eom diff --git a/docs/images/logical-1985516.png b/docs/images/logical-1985516.png new file mode 100644 index 0000000000000000000000000000000000000000..1ce7ce16dc8717e182da5f82fe0f7ee9c34137bf GIT binary patch literal 1961 zcmb_deN<9+7`~;Z35JG^)TU((oNJ2A)YREBP%I+UW}kiwI`WWHBi#lhmd+GCe#_84 z{HUR6Xk}rkX^V^$GabqNDs@i$C=)|P)LnC)`eWy8=WO@h=Y8+{ywC6Vo_n8j&rKo` z-Su>hbpZg-^T1=hz$^oRRe+8L7@1q(aUiiO%FEpqsE}-ugN0`3?)|#~pfU}j4%7nc z&q;)XxXH;$g+lT6?c3?;>Dk%Yxw$#DT0K8Mzp${dxVShoGcz?crBo_aDiyfmyVX)2 zm|)RfL~pSB!2xu1=UoO{Ya{SSq5uG4u!L1&q+%BUtQqmZ?migfH{R72+2sJ$dRnJk zWZm(J9_zFv8?49f`}o4+@Mf$hs$IxKC z6Fb!Y)#@<`m;2070TX`)-PJbJGz=++K|iuZ7=2$<`%8z(xK@HC6r7DFg*c2 zz{yNY=VZdxr)Dgj>)^2UD_E)0(tGZ+_1i$Pezz!<5_C-V3?Jt7{Zaf_@N>(7IoWhv z!?qkNbe4F8Jrt-qzEh%JK#hFuW}0QP_Unx?qzbe^G{sahf-s2%$tfk3)e?ev@(Dt5 zm8yVgb+=EBx^b_V*P_gz*>&x!k%e2!DK~2Wkzi~*+QX#OF!Uavp${U^tZnMc(faNe z4r5vMtx7J(^8Ov361zquN|jYB^K->kSlLV2*xKyn+Gdzi?B;xgjCHI zFfGgaQzz?qa z11!k2zZwx#mx~iwJ#6Rwc>IiZ;*S@&xwL?Wov{OSWq!(|@eo;3%;D9L1C2#hohn9e zW>delA}=I|m7ciie%#47=l3|g`M5Vi-@Wd>#=1e$$qF+uzpmRQFW7e{1O4c`$k_k9gd0DB2oqEc7555=IwjJCW> zKUI4jeIOj%dEnK{{L#n1$M2Npb|prZ+CPU4l31_IMBI}T?0ARCPfWiBwCf%@Rmm27 zdo#o%*A@A;(hF=<2C9hAq?oP>~x z7nC5xi-z)ItA Date: Wed, 28 Feb 2024 23:24:52 +0800 Subject: [PATCH 3/3] Change link --- docs/AboutUs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 1eb4dc8ee01..1f758957f6f 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -31,7 +31,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` ### Yan Jie - + [[github](http://github.com/logical-1985516)] [[portfolio](team/yanjie.md)]