tp

Internity User Guide

Introduction

Internity is a CLI based app for managing internship applications. Internity can help you manage and keep track of your internship applications more efficiently, perfect for Computer Science students who need to manage hundreds of applications. This guide explains how to install and use Internity to the fullest.

Table of Contents

• Quick Start
• Features
  • Adding an application : add
  • Deleting an application : delete
  • Updating an application : update
  • Viewing all applications: list
  • Finding by keyword: find
  • Setting/Changing username : username
  • Displaying dashboard : dashboard
  • Help : help
  • Exiting the program : exit
• FAQ
• Command Summary

---

Quick Start

1. Install Java 17. Confirm you have Java 17 installed by running java -version in your terminal.
   If you do not have Java 17 installed, download it from here.
2. Download Internity. Download the latest version of [CS2113-W14-4][Internity].jar from GitHub, onto any empty folder on your computer.
3. Launch the terminal Open a terminal, cd into the folder where you saved [CS2113-W14-4][Internity].jar.
4. Run the program. Run the command:
   java -jar [CS2113-W14-4][Internity].jar
5. Start using Internity! You can now start adding, deleting, updating and viewing your internship applications.
   You may refer to the Features below for details of each command.

Tip: Type help to view a list of available commands at any time.

---

Features

Notes about the command format

• Words in UPPER_CASE are placeholders that must be supplied by you.
  Example: delete INDEX → Please input delete 1
• The commands dashboard, help and exit will ignore any arguments. The command will still be valid.
• If using a PDF version, be careful when copying commands that span multiple lines as spaces surrounding line-breaks may be omitted.
• Uppercase, lowercase, digits and symbols are allowed. More specifically, only valid ASCII printable characters are allowed (character codes 32 to 126).

Adding an application: add

Add a new internship application with company, role, deadline and pay amount.
Refer to notes on using the command below.

Format

add company/COMPANY_NAME role/ROLE_NAME deadline/DEADLINE pay/PAY_AMOUNT

Example:

add company/Google role/Software Engineer Intern deadline/17-09-2025 pay/7000

This command adds an internship application at Google for the role of Software Engineer Intern with a deadline of 17 September 2025, and a monthly salary of $6000.

Notes on using add

• The fields MUST be entered in exactly the specified order: company, role, deadline, followed by pay.
• No duplicate field is allowed, so input exactly ONE of each field.
• By default, when an internship is added, the status is set to Pending. Use the update command to change the status.
• All indexes are in 1-indexed format.
• Field character limits: COMPANY_NAME ≤ 30 characters, ROLE_NAME ≤ 30 characters.
• COMPANY_NAME and ROLE_NAME must be alphanumerical.
• DEADLINE must be in dd-MM-yyyy format. Any valid past, present or future deadline can be added.
• PAY_AMOUNT must be a non-negative integer within Java's 32-bit signed integer range (maximum 2,147,483,647).

---

Deleting an application: delete

Delete an existing internship application from the internship list

Format:

delete INDEX

Example:

delete 2

This command deletes the internship application at index 2 from the list.

---

Updating an application: update

Use this command to update any field (company, role, deadline, pay, status) of an internship application.

Valid STATUS values

• Pending - You’re considering the internship but haven’t applied yet.
• Interested - You’ve found the internship and might apply.
• Applied - You’ve submitted your application.
• Interviewing - You’re currently in the interview process.
• Offer - You’ve received an internship offer.
• Accepted - You’ve accepted the offer.
• Rejected - The application was unsuccessful or withdrawn.

Format:

update INDEX field1/VALUE1 field2/VALUE2 ...

Example:

update 1 status/Accepted
update 2 company/Microsoft status/Interviewing

The 1st command updates the status of the internship application at index 1 to “Accepted”.

The 2nd command updates the company of the internship application at index 2 to “Microsoft” and its status to “Interviewing”.

Notes

• All field values must adhere to the constraints specified in the add feature.
• If duplicate valid field values are given, only the last field will be used.
  Example: update 1 company/ABC company/XYZ will update the company of the internship application at index 1 to "XYZ".

---

Listing all applications: list

Use this command to view all internship applications. You can optionally sort them by deadline in ascending or descending order.

Format:

list
list sort/ORDER

Example:

list
list sort/asc
list sort/desc

• list → shows all applications in the order they were added
• list sort/asc → sorts applications by deadline ascending
• list sort/desc → sorts applications by deadline descending

Notes

• The sort/ORDER parameter is optional. If omitted, the default listing order is by addition time.
• If two or more applications have the same deadline, they are further sorted by the order they were added.
• As the sorting works like a filter, the selected sorting order will not persist for subsequent listings.

---

Finding by keyword: find

Search for internship applications by company or role with a keyword. The search is case-insensitive.

Format:

find KEYWORD

Example:

find Software Engineer

This command lists all internship applications that contain the keyword “Software Engineer” in either its company or role fields.

---

Setting/Changing username: username

Use this command to set or change the username for the Internity application. Whitespace between names will be maintained.

Format:

username NEW_USERNAME

Example:

username Yoshikage Kira

This command changes the username to Yoshikage Kira and notifies the user.

---

Displaying dashboard: dashboard

Use this command to display a dashboard showing the current user’s information, total internships, nearest deadline, and a breakdown of internships by status.

Format:

dashboard

Notes

• This command is still valid if extra parameters are given
  Example: dashboard cs2113
• The Nearest Deadline displays the internship with the closest upcoming deadline. If no future deadlines exist, it shows the most recent past deadline and marks it as (OVERDUE!). It also shows the number of internships that share the same deadline (if any).
  Example:

  Nearest Deadline:
    31-10-2019 | Coffee Barista @ Sunbucks (OVERDUE!)
    (Found 2 other internship(s) with the same deadline)
  

---

Help: help

Use this command to display a help message with a list of available commands.

Format:

help

Notes

• This command is still valid if extra parameters are given
  Example: help me

---

Exit Internity: exit

Use this command to quit the program. Your data is saved.

Format:

exit

Notes

• This command is still valid if extra parameters are given
  Example: exit now

---

FAQ

• Q: How do I transfer my data to another computer?
  A: Make a copy of the data/ folder of the home directory that runs Internity.jar to the new computer. Ensure that the folder structure remains intact.

• Q: I have encountered an invalid command error. What do I do?
  A: Refer to the Features section for details on using a command.

• Q: Does Internity work without Internet?
  A: Yes, Internity does not require an active internet connection, allowing you to manage your internships seamlessly!

• Q: My application unexpectedly closed. Will my previous entries be saved?
  A: Yes, Internity automatically saves your data after each command, ensuring that your entries are preserved even in the event of an unexpected closure.

• Q: How can I reset my data to start fresh?
  A: Close the app and delete the data/internships.txt file. On next start, the app will create a new empty data file. Be careful: this deletes all saved internships.

• Q: I see warnings about corrupted lines being deleted when I start Internity — what happened?
  A: On startup, Internity scans the save file (data/internships.txt) for malformed or corrupted lines. If any problematic lines are found, the program automatically detects and removes those lines to keep the data consistent and prints a warning for each deleted line. These warnings appear before the welcome message.
  Important: the deletions are staged in memory and are NOT written back to the save file immediately. The cleaned data is only persisted to disk when the program executes a command. If you force-quit the program (for example, pressing Ctrl+C) before typing any command, the program exits without saving and the original save file will remain unchanged.

• Q: Does the username persist between sessions?
  A: Yes, the username is saved in the data file and automatically loaded when you start Internity.

• Q: Can I have duplicate internship applications?
  A: Yes, Internity allows multiple entries with the same company and role, as they may represent different opportunities or applications.

• Q: What if I enter a deadline in the past?
  A: You can add past deadlines without issue.

• Q: Is the pay amount monthly or annual?
  A: The pay field represents the monthly salary (e.g., in SGD or your local currency). It’s stored as a number without units, so you may choose to use any currency. —

Command Summary

Action	Command	Format	Example
Add Application	add	add company/COMPANY_NAME role/ROLE_NAME deadline/DEADLINE pay/PAY_AMOUNT	add company/Google role/Software Engineer Intern deadline/17-09-2025 pay/7000
Delete Application	delete	delete INDEX	delete 2
Update Application	update	update INDEX FIELD/VALUE	update 1 status/Interviewing
List Applications	list	list → list all applications in the order they were added list sort/ORDER → sort applications by deadline ascending (asc) or descending (desc)	list list sort/asc list sort/desc
Find Application	find	find KEYWORD	find Software Engineer
Set/Change username	username	username NEW_USERNAME	username Yoshikage Kira
Display Dashboard	dashboard	dashboard	dashboard
Help	help	help	help
Exit Internity	exit	exit	exit