🧑‍🏫 TutorProMax

TutorProMax is a desktop app for managing contacts, built specifically for private tutors in Singapore optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, TutorProMax can get your contact management tasks more efficiently than traditional GUI apps.

Why Choose TutorProMax?

TutorProMax isn't just another task management app — it's your ultimate companion for managing tutoring sessions and staying organized. Here's why you'll love it:

  • 📚 Tailored for Tutors
    Manage students, track lessons, set subject preferences, and manage tuition time with ease.

  • ⏱️ Fast workflow
    CLI commands let you manage your data quickly — perfect for fast typists.

  • 🔒 Offline and Secure
    No internet required. Your data stays private and local.

  • 🖥️ Portable
    Simple .jar file — no installation required.

🚀 TutorProMax helps you save time and stay organised!

Quick start

  1. Ensure you have Java 17 or above installed in your Computer.
    Mac users: Ensure you have the precise JDK version prescribed here.

  2. Download the latest .jar file from here.

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

  4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar tutorpromax.jar command to run the application.

    • cd path/to/your/folder
java -jar tutorpromax.jar
    • Alternatively, for Mac users, double-click on the folder where the jar file is in, and select open terminal at the filder

  5. A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
    Ui

  6. Type the command in the command box and press Enter to execute it. e.g. typing help and pressing Enter will open the help window.
    Some example commands you can try:

    • list : Lists all contacts.

    • add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 t/Math t/Science tt/Friday, 1000-1200 : Adds a contact named John Doe to TutorProMax.

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

    • clear : Deletes all contacts.

    • exit : Exits the app.

    • help : Check for all available commands and their format.

  7. Refer to the Features below for details of each command.

Parameters and Their Constraints

This section outlines the validation rules for each parameter used in TutorProMax commands.

Name

  • Allowed:
    • Unicode letters from various scripts (e.g., Latin, Chinese, Vietnamese).
    • Spaces, as long as the entire name is not just spaces.
    • Digits, but only when combined with letters (e.g., “peter the 2nd”). Purely numeric names are disallowed.
    • Standard punctuation like apostrophes ('), hyphens (-), slashes (/), dots (.), etc.
  • Disallowed:
    • Empty (e.g., "") or spaces only (e.g., " ").
    • Purely numeric (e.g., "12345").
    • Emojis (e.g., "🚀 Rocket").
    • Certain special symbols on their own (e.g., "^", "peter*").
  • Examples: Nguyễn Văn A, 张伟, Jean-Luc Picard, Vignesh S/O Muniyandi, Mary J. Blige, Dr. Tan

Phone

  • Format: Must be recognized as a valid phone number.
  • No letters: Letters ([A-Za-z]) are disallowed.
  • No consecutive spaces: Cannot contain multiple spaces in a row.
  • Must pass Google’s PhoneNumberUtil checks.
  • Examples: +65 9123 4567, 91234567, +1 408-555-1234

Email

  • Format: Must be in the form local@domain, with a valid domain name.
  • Allows alphanumeric and certain special characters for the local part, maximum of 64 characters.
  • Case-insensitive for the domain portion, maximum of 255 characters.
  • Examples: alice@example.com, bob.smith@university.edu, JOHN_DOE@my-school.org

Address

  • Not Blank: The address cannot be empty or consist only of spaces.
  • Examples:John street, block 123, #01-01, 12345 Maple Drive

Tuition Time

  • Required Format: <DAY>, <START_TIME>-<END_TIME>
    • DAY can be full (Monday, Tuesday, …) or short (Mon, Tue, …). Case‐insensitive.
    • START_TIME and END_TIME in 24‐hour format (HHMM), e.g., 1000-1200.
  • Crossing midnight is not supported (e.g., 2300-0000).
  • Examples: Friday, 1400-1600, Mon, 0900-1000

Tags

  • Optional: A person can have zero or more tags.
  • Alphanumeric
  • Examples: Math, Science, English

Features

Notes about the command format:

  • Words in UPPER_CASE are the parameters to be supplied by the user.
    e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe.

  • Items in square brackets are optional.
    e.g n/NAME [t/TAG] can be used as n/John Doe t/Math or as n/John Doe.

  • Items with …​ after them can be used multiple times including zero times.
    e.g. [t/TAG]…​ can be used as (i.e. 0 times), t/Math, t/Science t/English etc.

  • Parameters can be in any order.
    e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

  • Extraneous parameters for commands that do not take in parameters (such as help, list, exit and clear) will be ignored.
    e.g. if the command specifies help 123, it will be interpreted as help.

  • However, there are 2 extensions from the list command.

    • list without any command behind will be treated as the basic list command where all contacts will be listed.
    • list t/ will list all students with the particular tag (subject).
    • list tt/ will list all students with tuition on a particular day.

  • 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 : help

Shows a list of commands available. In addition, it shows a message explaining how to access the detailed help page.

help message

Format: help

Adding a person: add

Adds a person to the address book.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS tt/TUITION_TIME [t/TAG]…​

Tip: A person can have any number of tags (including 0)

Examples:

  • add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 tt/Monday, 1000-1200
  • add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/91234567 tt/Friday, 1400-1600 t/criminal

See Parameters and Their Constraints for the exact rules each field must follow.

Listing all persons : list

Shows a list of all persons in the address book. Specify a subject or tuition time with keyword to list only persons with matching subject or tuition time. If both subject and tuition time are specified, both filter will be applied and only persons that fulfil both criteria will be shown.

<<<<<<< HEAD Format: list [t/SUBJECT] [tt/TUITIONTIME]

Format:

  • list - Lists all students
  • list t/[keyword_tag] - Lists by tag
  • list tt/[keyword_tuition] - Lists by tuition day (e.g. Monday, mon, etc.)

Accepted day formats: You can use full day names (Monday, Tuesday, ...) or short forms (mon, tue, wed, thu, fri, sat, sun). The search is case-insensitive.

master

Examples:

  • list Lists all persons in the address book.
  • list t/math Lists all persons with keyword math in their tags (subjects). <<<<<<< HEAD
  • list tt/monday Lists all persons with keyword monday in their tuition times.
  • list t/math tt/Monday, 1000-1200 Lists all persons with keyword math in their tags (subjects) and tuition time of Monday, 1000-1200. =======
  • list tt/monday Lists all persons with tuition on Monday
  • list tt/mon – Also lists persons with tuition on Monday (short form).

master

Editing a person : edit

Edits an existing person in the address book.

Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

  • Edits the person at the specified INDEX. The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​
  • At least one of the optional fields must be provided.
  • Existing values will be updated to the input values.
  • When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
  • You can remove all the person’s tags by typing t/ without specifying any tags after it.

Examples:

  • edit 1 p/91234567 e/johndoe@example.com Edits the phone number and email address of the 1st person to be 91234567 and johndoe@example.com respectively.
  • edit 2 n/Betsy Crower t/ Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

See Parameters and Their Constraints for the exact rules each field must follow.

Locating persons by name: find

Finds persons whose names contain any of the given keywords.

Format: find KEYWORD [MORE_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 name is searched.
  • Only full words will be matched e.g. Han will not match Hans
  • Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

  • find John returns john and John Doe
  • find alex david returns Alex Yeoh, David Li
    result for 'find alex david'

Sorting : sort

Sort the address book based on field specified.

Valid fields: name, phone, email, address, tuition, tag

Format: sort field asc/desc

Examples:

  • sort name asc Sorts address book using ascending order of names.
  • sort tuition desc Sorts address book using descending order of tuition times.
  • sort email asc Sorts address book using ascending order of email addresses.

Possible Errors:

❌ If you try to sort by an invalid field, TutorProMax will return:

Invalid sort field. Valid fields: name, phone, email, address, tuition, tag

Deleting a person : delete

Deletes the specified person from the address book.

Format: delete INDEX

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

Examples:

  • list followed by delete 2 deletes the 2nd person in the address book.
  • find Betsy followed by delete 1 deletes the 1st person in the results of the find command.

Clearing all entries : clear

Clears all entries from the address book.

Format: clear

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

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

Editing the data file

AddressBook data are saved automatically as a JSON file [JAR file location]/data/addressbook.json. Advanced users are welcome to update data directly by editing that data file.

Caution: If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

Command History Navigation : arrow keys

Use the up (↑) and down (↓) arrow keys to navigate your previously entered commands.

  • Pressing up (↑) cycles backward through your command history.

  • Pressing down (↓) cycles forward to more recent commands.

  • This helps quickly re-enter or modify past commands without retyping.

Archiving data files [coming in v2.0]

Details coming soon ...

FAQ

Q: How do I transfer my data to another Computer?
A: Install TutorProMax on the new computer.

  • Run the app once to generate the necessary data folder.

  • On your original computer, navigate to the folder: [TutorProMax]/data/addressbook.json

  • Copy the addressbook.json file (this contains your data) to a USB drive or cloud storage.

  • On the new computer, go to the same directory: [TutorProMax]/data/

  • Replace the newly created addressbook.json with your copied version.

  • Launch TutorProMax. Your previously saved contacts should now be visible.

**Tip:** If you're unsure where the data folder is located, it is usually in the installation directory where **TutorProMax** was unzipped or installed. You can also check `preferences.json` for the exact path.

Known issues

  1. When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the preferences.json file created by the application before running the application again.
  2. If you minimize the Help Window and then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

Command summary

Action Format, Examples
Add add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS tt/TUITION_TIME [t/TAG]…​
e.g., add n/James Ho p/92224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 tt/Monday, 1000-1200 t/friend t/colleague
Clear clear
Delete delete INDEX
e.g., delete 3
Edit edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
e.g.,edit 2 n/James Lee e/jameslee@example.com
Find find KEYWORD [MORE_KEYWORDS]
e.g., find James Jake
Sort sort [field] asc/desc
e.g. sort name asc
List list [t/SUBJECT] [tt/TUITIONTIME]
e.g. list
e.g. list t/Math
e.g. list tt/Monday or list tt/mon
Help help