User Guide

Are you a CS student struggling to keep track of your internship applications? Do you feel tired of using spreadsheets? We have just the right tool.

Introducing PleaseHireUs (PHU), the internship tracking application made just for you!

Here are its main features:

• View the status of your application and assessment dates at a glance
• Overall statistics of status of all your internship applications in a bar chart

Now you will never miss any application deadlines or internship interviews again.

PleaseHireUs has been 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, PleaseHireUs can get your internship management tasks done faster than traditional GUI apps.

We hope you find PleaseHireUs to be useful in your internship hunt.

Table of Contents

• Table of Contents
• About this User Guide
• Navigating the User Guide
• Quick start
• Navigating the GUI
• Command Format
• Parameters Requirement
• Features
  • Adding an internship: add
  • Listing all internships : list
  • Locating internships by: find
  • View details of an internship: view
  • Editing internship : edit
  • Copy details of internship : copy
  • Deleting internship(s) : delete
  • Clearing all entries : clear
  • Undo previous command : undo
  • Redo previous undone command : redo
  • Viewing help : help
  • Exiting the program : exit
  • Saving the data
  • Editing the data file
  • Archiving data files [coming in v2.0]
• Command summary
• Prefix Summary
• FAQ
• Glossary
• Acknowledgements
• Appendix: Installing Java 11
• Appendix: Manually Editing the Save File

About this User Guide

This guides aims to:

1. Teach first-time users how to start using PleaseHireUs
2. Show and explain to users how to use the available features
3. Provide users with a summary of the available features
4. Provide advanced users with tips to improve their experience

Navigating the User Guide

Information Box

Tip Box

Warning Box

Highlights
Highlighted text refers to commands, parameters, field values or any user inputs
e.g. commands PARAMETERS

Keyboard Inputs
Boxed texts refers to keyboard inputs
e.g. enter ↑ ↓

Quick start

1. Ensure you have Java 11 or above installed in your Computer. You can refer to this.

2. Download the latest PleaseHireUs.jar here.

3. Copy the file to the folder you want to use as the home folder for your application.

4. Double-click the file to start the app. The following help window will appear the first time you open the application.

5. Close the help window, you will see a GUI similar to the one below. Note how the app contains some sample data.
   

6. Type a command in the command box and press enter to execute it.
   e.g. typing help and pressing enter will open the help window.
   

7. Below are some example commands you can try. You may refer to this for all the available commands.

• list : Lists all internships.

• add n/Grab p/software engineer pr/ASSESSMENT web/https://www.grab.com/sg/about : Adds a new internship to the internship tracker.

• delete 3 : Deletes the 3rd internship shown in the current list.

• clear : Deletes all internships.

• exit : Exits the app.

Navigating the GUI

COMMAND BOX

Enter your command here.

RESULT DISPLAY

Returns a feedback message after a command is executed.

MAIN PANEL

Displays the list of internships.

VIEW PANEL

Displays the internship being viewed in greater detail.

STATISTIC PANEL

The Bar Chart (located in the bottom right corner of the application) displays the number of applications on every stage of the possible application process which are currently listed.

For example, after carrying out the command, find c/n Shopee ,the bar chart will reflect the data for all internships whose company name contains the word Shopee.

REMINDER FOOTER

Displays the number of interviews, assessments or pending offers due in the next 7 days.

Command Format

Parameters Requirement

Here are the parameter requirements of commonly used parameters by commands in the Features section below.

Features

This section shows all features and commands which are supported by PleaseHireUs.

Adding an internship: add

Applied for an internship role at your dream company? Track your internship application by adding it into the list.

Format: add n/COMPANY_NAME p/POSITION [pr/APPLICATION_PROCESS] [d/DATE] [ph/PHONE] [e/EMAIL] [web/WEBSITE] [r/REMARK] [t/TAG]…​

• APPLICATION_PROCESS will be set to APPLIED by default.
• DATE will be set to today’s date by default.
• PHONE will be set to “NA” by default.
• EMAIL will be set to “NA” by default.
• WEBSITE will be set to “NA” by default.
• REMARK will be empty by default.
• TAG will be empty by default.

Examples:

• add n/Google ph/98765432 e/johnd@example.com r/Y2 summer break p/Backend Intern pr/APPLIED d/11-12-2022 web/https://careers.google.com/jobs t/high t/java
• add n/Grab p/software engineer pr/ASSESSMENT web/https://www.grab.com/sg/about
• add n/Gojek p/Mobile Intern

Executing command: add n/Gojek p/Mobile Intern

Listing all internships : list

See all the internships you have applied to.

Format: list [c/CATEGORY [DESCENDING]]

• Internships can be sorted by category in ascending or descending order.
• The CATEGORY is optional.
  • Without stating the category, list will display all internships in no particular order
  • Possible options for CATEGORY : COMPANY_NAME, POSITION, APPLICATION_PROCESS, DATE (case-insensitive)
• The DESCENDING parameter is optional.
  • The DESCENDING parameter can only be declared if the CATEGORY is stated
  • Possible options for DESCENDING:TRUE or FALSE (case-insensitive)
  • If DESCENDING is set to TRUE. List of internships will be displayed in descending order

Examples:

• list c/DATE TRUE
• list c/position

Executing command: list c/position

Locating internships by: find

Looking for specific internship applications? Find internships whose details in the target category matches the keyword/s you entered.

Format: find [c/CATEGORY] KEYWORDS…

• The search is case-insensitive. e.g. hans will match Hans
• The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans
• Only the target category is searched.
• The CATEGORY is optional.
  • Without stating the category, the search will take COMPANY_NAME as the target category
  • Possible options for CATEGORY : COMPANY_NAME, POSITION, APPLICATION_PROCESS, DATE, TAG (case-insensitive)
• KEYWORD must be provided.
  • The KEYWORD will match any word if the KEYWORD is contained in that word e.g. Han will match both Reyhan and Handy
  • Internships whose target category matches at least one keyword will be returned (i.e. OR search). e.g. c/company_name Hans Bo can return internships with company name of Hans Gruber or Bo Yang
  • To find an internship using the date category, all KEYWORD must be a valid date in dd-mm-yyyy format
  • To find an internship using the application process category, all KEYWORD must be a valid application process (case-insensitive) (i.e. Can only be: APPLIED, ASSESSMENT, INTERVIEW, OFFER, ACCEPTED, REJECTED)

Examples:

• find c/position engineer returns a list of internships with a position of Algorithm Engineer and Software Engineer
• find sea shop returns a list of internships with company name of Sea Labs, Shopee, and Shopback

Executing command: find sea shop

View details of an internship: view

Need to contact HR? View more details about your internship application.

Format: view INDEX

• Only the index is searched.

Examples:

• find sea shop followed by view 1 displays more details of the 1st internship in list.

Executing command: view 1

Editing internship : edit

Need to update your application status or change your assessment date? Edit the details of your internship application.

Format: edit INDEX [n/COMPANY_NAME] [p/POSITION] [pr/APPLICATION_PROCESS] [d/DATE] [ph/PHONE] [e/EMAIL] [web/WEBSITE] [r/REMARK] [t/TAG]…​

• Edit the details of internship at the specified INDEX.

Examples:

• list followed by edit 2 p/quant researcher d/01-01-2023 will edit the position and assignment date of the 1st internship in the list to quant researcher and 1 January 2023 respectively.
• find sea shop followed by edit 1 pr/REJECTED will edit the application process of the 1st internship in the results of the find command to REJECTED.

Executing command: edit 1 pr/REJECTED

Copy details of internship : copy

Quickly share your application details by copying it into your computer’s clipboard.

Format: copy INDEX

• Only the internship at the specified INDEX is copied.
• Full details of the internship will be copied into system clipboard.

Deleting internship(s) : delete

Deletes the specified internship(s) from the list.

Format: delete INDEX…​

• Deletes the internship at the specified INDEX.
• Can add multiple INDEX to delete multiple internships.

Examples:

• list followed by delete 1 3 deletes the 1st and 3rd internship from the list.
• find sea shop followed by delete 1 deletes the 1st internship in the results of the find command.

Executing command: delete 1

Clearing all entries : clear

Starting a new internship season? Clear all entries from the internship tracker.

Format: clear

Executing command: clear

Undo previous command : undo

Made a mistake? Undo the most recent command that modified the internship book.

Format: undo

Executing command: undo

Redo previous undone command : redo

Redo the most recent command that was undone.

Format: redo

Viewing help : help

If you need a quick refresher on the available commands, head right to the help page. Link to the user guide is also available.

Format: help

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

PleaseHireUs data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

Editing the data file

PleaseHireUs data is saved as a JSON file [JAR file location]/data/internshipbook.json. Advanced users are welcome to update the data directly by editing that data file.

For more information on editing the JSON file, click here

Caution: If your changes to the data file makes its format invalid, PleaseHireUs will discard all data and start with an empty data file at the next run.

Archiving data files [coming in v2.0]

Details coming soon …​

Command summary

Action	Undo	Format, Examples
Add		add n/COMPANY_NAME p/POSITION [pr/APPLICATION_PROCESS] [d/DATE] [ph/PHONE] [e/EMAIL] [web/WEBSITE] [r/REMARK] [t/TAG]…​ e.g., add n/Tiktok p/backend engineer
List		list [c/CATEGORY [DESCENDING]] e.g, list c/d true, list c/date
Find		find [c/CATEGORY] KEYWORDS…​ e.g., find c/p engineer
View		view INDEX e.g., view 1
Edit		edit INDEX [n/COMPANY_NAME] [p/POSITION] [pr/APPLICATION_PROCESS] [d/ASSESSMENT_DATE] [ph/PHONE] [e/EMAIL] [r/REMARK] [web/WEBSITE] [t/TAG]…​ e.g.,edit 2 p/Backend Intern pr/INTERVIEW d/01-11-2022
Copy		copy INDEX e.g., copy 1
Delete		delete INDEX…​ e.g., delete 1 3
Clear		clear
Undo		undo
Redo		redo
Help		help
Exit		exit

Prefix Summary

FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous PleaseHireUs home folder.

Glossary

Acknowledgements

• This project is adapted from AddressBook 3(AB3)
• Undo and Redo commands are adapted and modified from AddressBook 4(AB4)
• Libraries used: JavaFX, Jackson, JUnit5, TestFx
• The PleaseHireUs icon is obtained from flaticon

Appendix: Installing Java 11

1. Check if you have installed the correct version of java by running java -version in your terminal.
2. If Java is not installed in your computer or the Java version is different,
   1. For Windows users, you may download Java 11 here.
   2. For Mac users, you may download Java 11 here.
3. After installing, you may verify that the correct version of Java is installed by repeating step 1.

Appendix: Manually Editing the Save File

The save file contains a single object with a single field named "internships".

Below is an example of a valid save file format:

{
  "internships": [
    {
      "name": "Google",
      "phone": "87438807",
      "email": "alexyeoh@example.com",
      "remark": "Technical Interview (3 Questions - 2 Medium, 1 Hard)",
      "position": "Backend Intern",
      "applicationProcess": "APPLIED",
      "date": "20-10-2022",
      "website": "https://careers.google.com/",
      "tagged": ["Golang", "Summer"]
    },
    {
      "name": "TikTok",
      "phone": "NA",
      "email": "NA",
      "remark": "",
      "position": "Frontend Intern",
      "applicationProcess": "OFFER",
      "date": "25-10-2022",
      "website": "NA",
      "tagged": []
    }
  ]
}

The "internships" field is an array of objects which must contains all the following fields:

1. name: Represents the company name.
   A non-empty string which fulfills the COMPANY_NAME parameter constraints.

2. phone: Represents the phone number.
   EITHER "NA" which represents no phone number provided OR a string which fulfills the PHONE parameter constraints.

3. email: Represents the email.
   EITHER "NA" which represents no email provided OR a string which fulfills the EMAIL parameter constraints.

4. remark: Represents the remark.
   A (possibly empty) string which fulfills the REMARK parameter constraints.

5. position: Represents the position of the internship.
   A non-empty string which fulfills the POSITION parameter constraints.

6. applicationProcess: Represents the application process of the corresponding internship.
   A string which fulfills the APPLICATION_PROCESS parameter constraints. Note that the string is case-insensitive.

7. date: Represents the internship application date
   A string which fulfills the DATE parameter constraints.

8. website: Represents the company’s website
   EITHER "NA" which represents no website provided OR a string which fulfills the WEBSITE parameter constraints.

9. tagged: Represents a collection of tags for the corresponding internship
   An (possibly empty) array of strings with each string being non-empty and fulfilling the TAG parameter constraints.

Refer to this for the parameter requirements.