Skip to content

Commit

Permalink
Update DG with SortCommand
Browse files Browse the repository at this point in the history
File images to clean up directory
  • Loading branch information
ivanleekk committed Oct 24, 2023
1 parent ef12d24 commit 9aaf84a
Show file tree
Hide file tree
Showing 22 changed files with 290 additions and 132 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It is based on the AddressBook-Level3 project created by the [SE-EDU initiative]

> An applicant management program for Hiring Managers to track applicants throughout the hiring process.
![Ui](docs/images/Ui.png)
![Ui](docs/images/readme/Ui.png)

Staff-Snap is a desktop app for HR Managers to track staff information, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Staff-Snap can get your staff information management tasks done faster than traditional GUI apps.

Expand Down
10 changes: 5 additions & 5 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can reach us at the email `craigton.lian[at]gmail.com`

### Craigton Lian Ee John

<img src="images/craigtonlian.png" width="200px" height = "200px" style = "border-radius: 50%;">
<img src="images/developer-profiles/craigtonlian.png" width="200px" height = "200px" style = "border-radius: 50%;">


* Links:
Expand All @@ -28,7 +28,7 @@ You can reach us at the email `craigton.lian[at]gmail.com`

### Austin Huang De Yu

<img src="images/austinhuang1203.png" width="200px" height = "200px" style = "border-radius: 50%;">
<img src="images/developer-profiles/austinhuang1203.png" width="200px" height = "200px" style = "border-radius: 50%;">

* Links:
[[github](http://github.com/austinhuang1203)]
Expand All @@ -39,7 +39,7 @@ You can reach us at the email `craigton.lian[at]gmail.com`

### Ivan Lee Kai Kiat

<img src="images/ivanleekk.png" width="200px" height = "200px" style = "border-radius: 50%;">
<img src="images/developer-profiles/ivanleekk.png" width="200px" height = "200px" style = "border-radius: 50%;">


* Links:
Expand All @@ -52,7 +52,7 @@ You can reach us at the email `craigton.lian[at]gmail.com`

### Celestine Tan Yen Tong

<img src="images/celestinetan03.png" width="200px" height = "200px" style = "border-radius: 50%;">
<img src="images/developer-profiles/celestinetan03.png" width="200px" height = "200px" style = "border-radius: 50%;">


* Links:
Expand All @@ -66,7 +66,7 @@ You can reach us at the email `craigton.lian[at]gmail.com`

### Wang Jingting

<img src="images/jingting1412.png" width="200px" height = "200px" style = "border-radius: 50%;">
<img src="images/developer-profiles/jingting1412.png" width="200px" height = "200px" style = "border-radius: 50%;">


* Links:
Expand Down
368 changes: 252 additions & 116 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## User Interface Guide

![User Interface Guide Example](./images/userInterfaceGuide.png)
![User Interface Guide Example](images/user-guide/userInterfaceGuide.png)



Expand All @@ -34,7 +34,7 @@ Displays a message explaining how to access the help page.
Format: `help`

UI mockup:
![Help UI Mockup](./images/help.png)
![Help UI Mockup](images/user-guide/help.png)

---
### `add` : Adding a new applicant
Expand All @@ -48,7 +48,7 @@ Example:
* `add n/Jane Greenwood p/Project Manager e/[email protected] hp/91234567`

UI mockup:
![Add UI Mockup](./images/add.png)
![Add UI Mockup](images/user-guide/add.png)

---
### `edit` : Editing an applicant
Expand All @@ -65,7 +65,7 @@ Example:
* `edit 2 hp/80081234 e/[email protected]` edits the phone number and email of the 2nd applicant in the list.

UI mockup:
![Edit UI Mockup](./images/edit.png)
![Edit UI Mockup](images/user-guide/edit.png)

---
### `list` : Listing all applicants
Expand All @@ -75,7 +75,7 @@ Displays the full list of all applicants.
Format: `list`

UI mockup:
![List UI Mockup](./images/list.png)
![List UI Mockup](images/user-guide/list.png)

---
### `delete` : Deleting an applicant
Expand All @@ -92,7 +92,7 @@ Examples:
* `sort d/name` followed by `delete 3` deletes the 3rd person in the sorted applicant list.

UI mockup:
![Delete UI Mockup](./images/delete.png)
![Delete UI Mockup](images/user-guide/delete.png)

---
### `find` : Finding an applicant by name
Expand All @@ -111,7 +111,7 @@ Examples:
* `find IVAN CHEW` finds any applicant whose name contains “ivan” or contains “chew”.

UI mockup:
![Find UI Mockup](./images/find.png)
![Find UI Mockup](images/user-guide/find.png)

---
### `sort`: Sorting applicants by descriptor
Expand All @@ -126,7 +126,7 @@ Examples:
* `sort d/phone` sorts the applicant list by phone numbers in ascending order.

UI mockup:
![Sort UI Mockup](./images/sort.png)
![Sort UI Mockup](images/user-guide/sort.png)

---
### `addi` : Adding an interview to an applicant
Expand Down Expand Up @@ -162,7 +162,7 @@ Clears all the current data stored in the system.
Format: `clear`

UI mockup:
![Clear UI Mockup](./images/clear.png)
![Clear UI Mockup](images/user-guide/clear.png)

---
### `exit` : Exiting the program
Expand Down
22 changes: 22 additions & 0 deletions docs/diagrams/SortCommandActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
@startuml
'https://plantuml.com/activity-diagram-beta

start
:User enters sort command syntax;
:ApplicantBookParser parses command_word;
:SortCommandParser parses arguments;
if (Descriptor is present) then (true)
:Execute SortCommand;
:Update Applicant Descriptor;
:Refresh Applicant List;
:Display success message;
:Show updated list in GUI;
stop
else (false)
:Throw ParseException with
invalid command format
message and proper Sort
syntax;
:Display error message;
stop
@enduml
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![CI Status](https://github.com/AY2324S1-CS2103T-W08-1/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2324S1-CS2103T-W08-1/tp/actions)
[![codecov](https://codecov.io/gh/AY2324S1-CS2103T-W08-1/tp/graph/badge.svg?token=7PPPGQNQFE)](https://codecov.io/gh/AY2324S1-CS2103T-W08-1/tp)

![Ui](images/Ui.png)
![Ui](images/readme/Ui.png)

**Staff-Snap is a desktop application for managing your employee details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

Expand Down

0 comments on commit 9aaf84a

Please sign in to comment.