User Guide

Welcome to FindMyIntern!

The purpose of this user guide is to help both new and experienced users with using FindMyIntern.

• If you are a new user, we recommend checking out the introduction to get a better idea of what FindMyIntern can do. We also recommend going through the special formats used in this user guide to understand what they mean. If you have no prior experience with command line interfaces, we recommend reading this guide.

• If you are an experienced user, you can use the table of contents to jump straight to what you are looking for.

---

Introduction

Are you a student applying for internships? Do you have trouble remembering what you have applied? Or is using spreadsheets too troublesome for you? FindMyIntern is the perfect solution for you!

FindMyIntern is a desktop application that helps you easily keep track of your internship applications.

FindMyIntern helps you to

• Consolidate all applications into a single place
• Find particular internship applications
• Easily view applications with different statuses

---

Table of Contents

The user guide is divided into different sections. Click on any of the sections to jump right into that section!

---

Special formats

Here are some special formats to take note of when reading this user guide:

This code block denotes commands, parameters, user inputs or file names.

---

Command Line Guide

Simply type in:

1. The command.
   • Example: add represents the add command.
2. The prefix indicating a field.
   • Example: The prefix c/ indicates the company field.
3. The field to be added or updated.
   • Enter directly after the prefix.
   • Example: For c/TikTok, Tiktok represents the actual company field to be added.
4. Repeat steps 2 and 3 to add or update more fields in a single command.

---

Quick Start

Setting up

1. Ensure you have Java 11 or above installed in your Computer:
   1. Open up the command prompt/Terminal in your respective OS:
      • For Windows:
        Open up the command prompt by pressing the Windows key and searching Command Prompt.
      • For Mac:
        Click on Finder, then open the /Application/Utilities folder by pressing
        Command + Shift + U + + U, and finally open the Terminal application.
      • For Linux:
        Open up the command prompt by pressing Ctrl + Alt + T.
   2. Once the command prompt/Terminal is opened, type in java -version.

   3. It should look similar to this:

      

   4. If your version starts with "11.*.*.*" where * represents any number, you are good to go!
   5. Otherwise, you can download Java 11 here.
      
      

2. Download the latest findmyintern.jar from here.

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

4. Double-click the file to start the application.

Adding your first internship application

Now that you’ve downloaded FindMyIntern, you can start managing your internship applications. Let’s start by adding your first internship application.

1. Open FindMyIntern by double-clicking findmyintern.jar if you have not already done so.

2. The GUI (Graphical User Interface) similar to the below should appear in a few seconds. FindMyIntern will load some sample data.
   

   

3. Let’s add your first internship application with the add command!

4. Type add c/Shopee l/careers.shopee.sg d/My first internship application a/27 Oct and press Enter to execute it.

   
   

5. Congratulations! You have just added your first internship application to FindMyIntern! A message like the one below showing the result of your command should appear in the result box.

   

   If you would like to clear the sample data, use the clear command.

6. FindMyIntern offers so much more in managing your internship applications. Check out the commands section for more commands you can use.

---

Features

FindMyIntern has many features and commands available. Before using the commands, here are some things to take note of.

Commands

To navigate to a specific command, you can just click on any of the commands to jump straight into it.

• Adding an internship application: add
• Editing an internship application: edit
• Marking an internship application status: mark
• Listing all internship applications: list
• Deleting an internship application: delete
• Finding for an internship application: find
• Filtering for internship applications of a specific status: filter
• Sorting the internship applications: sort
• Clearing all internship applications: clear
• Viewing help: help
• Exiting the program: exit

Adding an internship application: add

Adds an internship application to FindMyIntern. Using this command, you can easily add and view the details of your application in the displayed internship application list.

• Default application status is “Applied”.
• INTERVIEW_DATE_TIME is optional, but if included, will automatically change application status to “Shortlisted”.
• TAG is optional, but can be used multiple times.
• TAG can be used to attach keywords to an internship application which may help in your internship application tracking.
  • There are no restrictions on what can be a TAG, other than containing only alphabets and spaces.
• See Appendix: Field constraints for constraints on fields such as LINK and TAG.

Examples:

• add c/Apple l/https://jobs.apple.com/en-sg d/Software engineering internship a/11/10/2022 - Adds an internship application for Apple into the list
• add c/Grab l/https://grab.careers/teams/campus d/Marketing internship a/11 Oct i/23 Nov, 3:00 pm - Adds an internship application for Grab into the list
• add c/Shopee l/careers.shopee.sg/students d/Data analyst internship a/20 Oct 2022 i/28 Nov 16:00 t/data analyst t/summer - Adds an internship application for Shopee into the list

Editing an internship application: edit

Edits an existing internship application in FindMyIntern. Using this command, you can easily change any details if you have accidentally mistyped some information.

• Edits the internship application at the specified INDEX. The index must be a positive integer 1, 2, 3…
  • The index refers to the index number shown in the current displayed internship application list.
• At least one of the optional fields must be provided.
• When editing INTERVIEW_DATE_TIME, the application status will change to “Shortlisted”.
• When editing tags, the existing tags will be removed and replaced with the input tags.
• Tags can be removed by typing t/ without specifying any tags after it.
• Editing an internship application is only allowed if it does not result in duplicates. Two internship applications are considered as duplicates if both their COMPANY and TAG are identical.
• See Appendix: Field constraints for constraints on fields such as LINK and TAG.

Examples:

• edit 1 d/Data analyst intern - Edits the description of the 1st internship application in the list to Data analyst intern.
• edit 2 i/23/11/2022 15:00 - Edits the interview date/time of the 2nd internship application to 23 Nov 2022, 3:00 PM, and changes the application status to “Shortlisted”.
• edit 3 t/frontend t/summer - Edits the tags of the 3rd internship application, removing existing tags and adding frontend and summer tags

Marking an internship application status: mark

Marks an internship application status. Using this command, you can easily change the application status if the company has gotten back to you.

• Updates the internship application at the specified INDEX. The index must be a positive integer 1, 2, 3…
  • The index refers to the index number shown in the current displayed internship application list.
• Updates the internship application to the specified APPLICATION_STATUS.
• APPLICATION_STATUS is case-insensitive.

Examples:

• mark 3 s/interviewed - Marks the 3rd internship application status as interviewed
• mark 2 s/Accepted - Marks the 2nd internship application status as accepted
• mark 4 s/REJECTED - Marks the 4th internship application status as rejected

Listing all internship applications: list

Shows a list of all internship applications. Using this command, you can easily update the displayed internship application list to show you all internship applications, if it has been filtered by find or filter.

Deleting an internship application: delete

Deletes an internship application. Using this command, you can easily delete an internship application that you do not want to keep track of.

• Deletes the internship application at the specified INDEX. The index must be a positive integer 1, 2, 3…
  • The index refers to the index number shown in the current displayed internship application list.

Examples:

• delete 4 - Deletes the 4th internship application in the list.

Finding for internship applications or tags: find

Finds internship applications where the company’s name and tags contain any of the given keywords. Using this command, you can easily find an internship application that you are looking for.

• The search is case-insensitive e.g google will match Google
• Partial words will be matched e.g. goo will match an application where the company’s name or tag contains the word goo

Examples:

• find tiktok returns internship application(s) and tag(s) containing tiktok
• find google backend returns internship application(s) and tag(s) containing google and backend

Filtering for internship applications of a specific status: filter

Filters for internship applications of the specified application status. Using this command, you can easily filter for the internship applications with the application status that you are interested in.

• APPLICATION_STATUS is case-insensitive.

Examples:

• filter accepted - Shows a list of internship applications marked as accepted
• filter Rejected - Shows a list of internship applications marked as rejected

Sorting the list of internship applications: sort

Sorts the internship applications with the latest date at top to earliest at the bottom. Using this command, you can easily view the internship applications that have interviews coming up soon.

• Sort criteria must be one of the following:
  • applied
  • interview

Examples:

• sort applied will sort the internship applications according to applied date
• sort interview will sort the internship applications according to interview date

Clearing all internship applications: clear

Clears all internship applications from FindMyIntern. Using this command, you can easily clear all internship applications at once and start afresh.

Viewing help: help

Shows a message with a link to the user guide, and the data file location. Using this command, you can easily navigate to our user guide in case you have any difficulties in using FindMyIntern.

• Click on the link to copy the user guide link.

Exiting the program: exit

Exits the program. Using this command, you can quit FindMyIntern safely.

Saving and Editing

Saving the data

FindMyIntern’s 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

FindMyIntern’s data is saved as a JSON file [JAR file location]/data/findmyintern.json. The data file location can also be found in the help message: see help command.

Advanced users are welcome to update data directly by editing that data file.

UI Elements

This section explains how to use certain elements in the user interface which can enhance your FindMyIntern experience.

Links

Clicking on links will copy the URL of the link to the clipboard. The URL can then be pasted into any browser.

A tooltip is shown when the link is hovered.

Tags

Tags that are added are automatically converted to lowercase. They are displayed in lexicographical order.

A tooltip containing the full tag name is shown when a tag is hovered.

The maximum number of tags that will be displayed is 5. Additional tags that are not displayed will be shown as a count. A tooltip containing the additional tags is shown when the count is hovered.

---

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 FindMyIntern home folder.

---

Appendix

This section specifies the input details that you have to be aware of in FindMyIntern.

• Field Constraints
• Application Status
• Link Formats
• Date/Time Formats

Field Constraints

Commands like add and edit accept fields, their constraints are specified below.

There are no constraints for a field if the constraints box is empty for that field.

Field	Constraints
c/COMPANY
l/LINK	See link formats
d/DESCRIPTION
a/APPLIED_DATE	See date/time formats
i/INTERVIEW_DATE_TIME	See date/time formats
t/TAG	Must only contain alphabets and spaces

Application Status

Application status refers to the current status of an internship application. Each internship application is tagged with an application status.

Application status as an input field must be one of the following:

Application status	Explanation	Remark
applied	You have applied for this internship	Default application status
shortlisted	Company has shortlisted you for interview	Adding/editing the interview date/time of an internship application will change application status to "Shortlisted"
interviewed	You have been interviewed for this internship application
accepted	You have accepted this internship
rejected	You have rejected or been rejected for this internship

Link Formats

For Link, the format allowed is [SCHEME][HOSTNAME]SLD.TLD[MORE_TLDS][PATH].

Example:

• [https://][careers.]google.com[.sg][/students]

The constraints are:

Field	Constraints	Example
SCHEME	Only http:// and https:// are allowed	https://
HOSTNAME	Must only contain alphabets and numbers Must end with the character '.' Must be at least 2 characters and at most 8 characters long excluding the '.' character at the end	careers.
SLD	Must only contain alphabets, numbers and the character '-' Must end with the character '.' Must be at least 1 character and at most 63 characters long excluding the '.' character at the end	google.
TLD	Must only contain alphabets and numbers Must end with the character '.' if there is another TLD after the current one Must be at least 2 characters and at most 8 characters long	com.sg
PATH	Must only contain alphabets, numbers and the characters '+&@#/%=~$.?' Must start with the character '/'	/students

Date/Time Formats

For APPLIED_DATE, the formats allowed:

Format	Input
d MMM yyyy	7 Oct 2022
d/M/yyyy	7/10/2022

For INTERVIEW_DATE_TIME, the formats allowed:

Format	Input	Remark
d MMM yyyy HH:mm	7 Oct 2022 15:00
d/M/yyyy HH:mm	7/10/2022 15:00
d MMM yyyy, h:mm a	7 Oct 2022, 3:00 pm	Take note of the comma after the date space between the time and AM/PM
d/M/yyyy, h:mm a	7/10/2022, 3:00 pm	Take note of the comma after the date space between the time and AM/PM

---

Command Summary

Action	Format, Examples
Add	add c/COMPANY l/LINK d/DESCRIPTION a/APPLIED_DATE [i/INTERVIEW_DATE_TIME] [t/TAG]… e.g., add c/Apple l/https://jobs.apple.com/en-sg d/Software engineering internship a/11/10/2022
Edit	edit INDEX [c/COMPANY] [l/LINK] [d/DESCRIPTION] [a/APPLIED_DATE] [i/INTERVIEW_DATE_TIME] [t/TAG]… e.g., edit 1 d/Data analyst intern
Mark	mark INDEX s/APPLICATION_STATUS e.g., mark 3 s/interviewed
List	list
Delete	delete INDEX e.g., delete 4
Find	find KEYWORD [MORE_KEYWORDS]… e.g., find google
Filter	filter APPLICATION_STATUS e.g., filter accepted
Sort	sort CRITERIA e.g., sort applied
Clear	clear
Help	help
Exit	exit