🎉 InternBook User Guide 📚
Welcome to InternBook! 💻📚
Hey there, future interns! Since you are here, we assumed that you are also a student, like us, who is starting your internship search. Welcome to InternBook, your go-to companion in the exciting journey of applying for internships!
Who Are We? 🤝
We are a dynamic team of five students who have been in your shoes, feeling the struggle of juggling multiple internship
applications while trying to keep track of every detail. We get it - those Excel spreadsheets might seem like a good idea
@@ -65,43 +65,43 @@
Ensure you have Java 11 installed in your computer. If you do not have it installed, download it from here.
Not sure if you have Java 11 downloaded, here's how to check.
- Download the latest
internBook.jarfrom here. - Copy the file to the folder you want to use as the home folder for your InternBook.
💡 TIP: Create a folder with internBook.jar so that the data files created will be stored in the same folder. Check our FAQ to see how to open it in your terminal.
- Open a command terminal,
cdinto the folder you put the jar file in, and use thejava -jar internBook.jarcommand to run the application.
💡 TIP: -If you are struggling to figure out the path to
cdinto, you can use the File Explorer in your OS to copy the file path and directlycdto that.
Alternatively, you can simply navigate to the file location the File Explorer and double-click on the application to run.
A GUI similar to the one displayed below should appear in a few seconds. Note how the app already contains some sample data.
Try out a command!
+If you are struggling to figure out the path tocdinto, you can use the File Explorer in your OS to copy the file path and directlycdto that.Alternatively, you can simply navigate to the file location the File Explorer and double-click on the application to run.
A GUI similar to the one displayed below should appear in a few seconds. Note how the app already contains some sample data.
Try out a command!
For instance, typinghelpand pressing Enter will open the help window.
You can also try out the following commands:list: Lists all contacts.add -n Company -e company@gmail.com -t Role: Adds a company contact with nameCompany, emailcompany@gmail.comand tagRole.delete 1: Deletes the contact with index1.exit: Exits the app.
Refer to the Features below for details of each command.
Features
Notes about the command format:
Words in
UPPER_CASEare the inputs to be supplied by the user.
e.g. inadd -n COMPANY,COMPANYis the input which can be used asadd -n DBS.Fields in square brackets are optional.
e.g-n COMPANY [-p PHONE_NUMBER]can be used as-n DBS -p 61234567or as-n DBS.Field with
… after them can be used multiple times.
e.g.-t TAG…can be used as-t Software Engineer,-t Software Engineer -t Data Analystetc.Fields can be in any order.
e.g. if the command specifies-n COMPANY -t Software Engineer,-t Software Engineer -n COMPANYis also acceptable.Extraneous parameters for commands that do not take in inputs (such as
help,list,exitandclear) will be ignored.
-e.g. if the command specifieshelp 123, it will be interpreted ashelp.❗️ Important: Dates will only show in the GUI if both start date and end date are present.
If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
Viewing help :
helpShows a pop-up window of our user guide for easier access.
Format:
help
Listing all companies :
listShows a list of all companies in the InternBook.
Format:
listAdding a company:
addAdds a company to the InternBook.
Format:
add -n COMPANY -e EMAIL -t TAG… [-p PHONE_NUMBER] [-d1 START_DATE] [-d2 END_DATE]Field Optional/Compulsory Flag Remarks Company Name Compulsory -n Names should only have alphanumeric characters and spaces Email Compulsory -e Emails should be of the format local-part@domain and adhere to the following constraints:
1. The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters. The local-part may not have consecutive special characters.
2. This is followed by a '@' and then a domain name. The domain name is made up of domain labels separated by periods.
The domain name must:
- end with a domain label at least 2 characters long
- have at least 2 domain labels separated by a dot (.)
- have each domain label start and end with alphanumeric characters
- have each domain label consist of alphanumeric characters, separated only by hyphens, if any.Tag (Can be used as roles) Compulsory -t Multiple tags are allowed
Tags should only have alphanumeric characters and "/"
Tags should not start or end with "/"
Tags are case insensitive and the first alphabet of each word will be capitalisedPhone Optional -p Phone numbers should be 3 or more digits Start Date Optional -d1 Dates should be in the form YYYY-MM-DD
Start date must be earlier than or equals to end dateEnd Date Optional -d2 Dates should be in the form YYYY-MM-DD
End date must be later than or equal to start dateExamples:
add -n DBS -t Software Engineer -e dbs@example.com -d1 2024-04-04 -d2 2024-05-05add -n Tiktok -t Data Analyst -e tiktok@example.com -p 61234567 -t AI Engineer
ℹ️ Remark:
- We allow the adding of duplicate companies with different start dates and end dates.
- This is fully intended and not a bug as this can allow users to keep track of different application windows of the same role in the same company.
- Check out our FAQ to understand how we distinguish duplicate entries.
- Start date can be added without the end date, and vice versa. However, when either dates are not entered, the record will -not show the dates. As shown below.
Here are the steps to add a company with examples of error messages and how to deal with them:
- Input:
add -n Tik_Tok -p 91234-567 -e adasd.com -t Soft-ware Engineer -d1 04-05-2024 -d2 2024-04-14
- Error: Name cannot contain "_".
-
- Correction: Remove "_".
- Error: Name cannot contain "_".
-
- Input:
add -n TikTok -p 91234-567 -e adasd.com -t Soft-ware Engineer -d1 04-05-2024 -d2 2024-04-14
- Error: Phone number should only contain numbers.
-
- Correction: Remove non-numeric characters.
- Error: Phone number should only contain numbers.
-
- Input:
add -n TikTok -p 91234567 -e adasd.com -t Soft-ware Engineer -d1 04-05-2024 -d2 2024-04-14
- Error: Date format should be YYYY-MM-DD.
-
- Correction: Adjust date format.
- Error: Date format should be YYYY-MM-DD.
-
- Input:
add -n TikTok -p 91234567 -e adasd.com -t Soft-ware Engineer -d1 2024-04-15 -d2 2024-04-14
- Error: Start date should precede end date.
-
- Correction: Swap date order.
- Error: Start date should precede end date.
-
- Input:
add -n TikTok -p 91234567 -e adasd.com -t Soft-ware Engineer -d1 2024-04-14 -d2 2024-04-15
- Error: Incorrect email format.
-
+e.g. if the command specifies help 123, it will be interpreted ashelp. ❗️ Important: Dates will only show in the GUI if both start date and end date are present.
If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
- Error: Incorrect email format.
-
