FitDesk User Guide

FitDesk is a desktop app for front-desk receptionists at small-to-medium private fitness gyms managing member registrations and daily check-ins. Tailored for fast, keyboard-centric workflows, FitDesk empowers receptionists to work more efficiently, reducing wait times and increasing productivity.

---

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 your AddressBook.

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar addressbook.jar command to run the application.
   A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
   

5. 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. Use the Up and Down arrow keys (when the command box is focused) to cycle through previously entered commands.
   Some example commands you can try:

   • list : Lists all contacts.

   • add n/John Doe p/98765432 g/M d/19-01-2004 m/annual e/johnd@example.com ec/98723347 : Adds a member named John Doe to the member list.

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

   • clear : Deletes all contacts.

   • exit : Exits the app.

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

---

Features

Viewing help : help

Shows a message explaining how to access the help page.

Format: help

Adding a member: add

Adds a member to the member list.

Format: add n/NAME p/PHONE_NUMBER g/GENDER d/DATE_OF_BIRTH m/MEMBERSHIP_TYPE e/EMAIL ec/EMERGENCY_CONTACT

Examples:

• add n/John Doe p/98765432 g/M d/19-01-2004 m/annual e/johnd@example.com ec/98723347

A new member John Doe is added to the member list

• add n/Betsy Crowe m/monthly ec/93349011 e/betsycrowe@example.com g/F d/28-01-2002 p/91234567

Listing all persons : list

Shows a list of all members in the list.

Format: list

Example:

Editing a person : edit

Edits an existing member in the list.

Format: edit INDEX [n/NAME] [p/PHONE_NUMBER] [g/GENDER] [d/DATE_OF_BIRTH] [m/MEMBERSHIP_TYPE] [j/JOIN_DATE] [e/EMAIL] [ec/EMERGENCY_CONTACT]

• Edits the member at the specified INDEX. The index refers to the index number shown in the displayed member 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.

Examples:

• edit 1 p/91234567 e/johndoe@example.com Edits the phone number and email address of the 1st member to be 91234567 and johndoe@example.com respectively.
• edit 2 n/Betsy Crower m/annual Edits the name and membership type of the 2nd member to be Betsy Crowerand annual respectively.

Locating members by keyword: find

Finds members whose fields contain the search query as a substring.

Format: find QUERY

• The search is case-insensitive. e.g hans will match Hans
• Only text-based fields are searched: name, phone, email, gender, emergency contact, membership type, and membership status. Date-based fields (date of birth, join date, expiry date) are not searchable.
• The entire query is matched as a literal substring against each field. e.g. find john doe will only return members whose field contains "john doe", not members with just john or just doe

Examples:

• find John returns members with John in any field
• find john doe returns members whose name (or other field) contains "john doe"
  
• find 9123 returns members whose phone number or other field contains 9123
• find annual returns members with annual membership type

Filtering members by fields: filter

Filters member list and displays members who have fields matching the given attribute.

Format: filter [s/STATUS] [g/GENDER] [m/MEMBERSHIP_TYPE] [age>/AGE] [age</AGE] [age=/AGE] [j>/DATE] [j</DATE] [exp>/DATE] [exp</DATE] [exp=/DATE]

Examples:

• filter s/valid returns list of members with valid memberships

Deleting a member : delete

Deletes the specified member from the list.

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.

  1. list

     

  2. delete 2

  

• find Alex followed by delete 1 deletes the 1st person in the results of the find command.

Renewing a membership: renew

Renews specified member's membership.

Format: renew INDEX [m/MEMBERSHIP_TYPE]

• Renews the member's membership at the specified INDEX. The index refers to the index number shown in the displayed member list. The index must be a positive integer 1, 2, 3, …​
• MEMBERSHIP_TYPE is an optional field.
• Expiry date will be updated.
• Membership type will be updated if included in the command.

Examples:

• renew 2 renews membership of the 2nd member in the list to 11-04-2026
• renew 1 m/monthly renews membership and updates membership type of the 1st member in the list to 11-04-2027 and Monthly respectively.

Adding a remark to a member : remark

Adds or edits a remark for the specified member.

Format: remark INDEX r/[REMARK]

• Edits the remark of the member at the specified INDEX. The index refers to the index number shown in the displayed member list. The index must be a positive integer 1, 2, 3, …​
• Existing remark will be overwritten by the input.
• Providing an empty remark (i.e. r/ with nothing after it) removes the remark from the member.

Examples:

• remark 1 r/Likes to swim. adds the remark Likes to swim. to the 1st member.
• remark 2 r/ removes the remark from the 2nd member.

Viewing the details of a person : details

Shows the details of the specified member from the list.

Format: details INDEX

• Shows the details of 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 details 1 shows the details of the 1st member in the address book.

  1. list

     

  2. details 1

     

• find David followed by details 1 shows the details of the 1st member in the results of the find command.

  

Clearing all entries : clear

Clears all entries from the address book.

Format: clear

Undoing the last command : undo

Undoes the most recent undoable command (add, edit, delete, clear).

Format: undo

Example:

• undo

  

  

Navigating command history

Allows you to quickly re-use previously entered commands using the arrow keys in the command box.

• Press the Up arrow key to navigate to the previous command in history.
• Press the Down arrow key to navigate to the next command in history.
• The cursor will be placed at the end of the text after navigating.
• Pressing Down past the most recent command clears the command box.

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

FitDesk 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

FitDesk 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.

Archiving data files [coming in v2.0]

Details coming soon ...

---

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

---

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