Repository navigation
Releases
TuteeDex v1.6
TuteeDex v1.6 is our final release for private tutors to manage student profiles, weekly lesson schedules and outstanding fees through a command-driven desktop interface.
What's new since v1.5
- Safer deleting:
delete INDEXnow shows a preview, and the student is only removed afterdelete confirm. - Data safety: TuteeDex warns you when the data file cannot be loaded, and keeps your filtered view if a save fails.
- Better duplicate checks: Students are treated as duplicates even when only letter case or spacing differs.
- Stricter input: Unknown prefixes such as
x/are rejected inadd, the same as inedit. International names are supported. - Safer CSV export: Subjects and tags that start with a formula character are escaped.
- Polished interface: New TuteeDex icon, tiled background, pixel buttons, full subject and lesson text on each card, and a
DD - MMMheader date. - Documentation: Updated User Guide and Developer Guide to match this release.
Getting started
- Install Java 25.
- Download
TuteeDex.jarbelow into an empty folder. - Run
java -jar TuteeDex.jarfrom that folder.
See the User Guide for all commands.
TuteeDex v1.5
TuteeDex v1.5 is our release candidate for private tutors to manage student profiles, weekly lesson schedules, tuition balances, and records through a command-driven desktop interface.
What's new since v1.4
- Weekly lesson schedules: Store a day and start time with every subject, group students using
list -subjects, and keep each student's lesson slot visible. - Flexible sorting and filtering: Sort by name, outstanding amount, tuition start date, or upcoming lesson. Combine subject and tag filters, and use summary views without losing the current student selection.
- CSV import and safer export: Preview and confirm CSV imports, preserve complete student records, reject malformed rows, and protect exported values from spreadsheet-formula interpretation.
- Balance tracking: Record payments with
paid, add new charges withcharge, and view clear outstanding-balance feedback. - Persistent workflow: TuteeDex restores the last list or find view and sort order when reopened.
- Improved archive workflow: Archive and restore students by displayed index while preserving their profile, notes, tags, subjects, and balances.
- Refined interface: A local date and 24-hour clock, readable wrapped command results, larger profile tooltips, an improved Help window, and safer recovery when a saved window position is no longer visible.
- Quality and documentation: Stronger input validation, calendar-date checks, clearer messages, broader automated test coverage, and updated User and Developer Guides.
Product in action
The interfaces below use fictional demonstration profiles and are cropped to the application content only.
Student overview
Weekly lessons grouped by subject
Upcoming lessons first (sort slot/asc)
A student profile (view 1)
Filtering by tag (list t/Needs revision)
Archived students (list -archived)
Help window (help or F1)
Getting started
- Install Java 25 using the course-prescribed Java distribution for your operating system.
- Download
TuteeDex.jarand place it in a new writable folder. - Open a terminal in that folder and run
java -jar "TuteeDex.jar". - Run
helpto see the available commands.
See the User Guide for complete command syntax and examples.
Known limitation
- Data created before the student-profile schema change is incompatible. Start this version in a new folder or remove the old data file after making a backup.
Full changelog: v1.4...v1.5
TuteeDex v1.4
TuteeDex v1.4 is our alpha release for private tutors to manage student profiles, subjects, notes and outstanding fees through a command-driven desktop interface.
What's new since v1.3
- Subjects, tags and notes: Add one or more subjects using repeated
s/prefixes, optional tags usingt/, and a free-text note usingnotes/. These fields are saved with each profile. - Edit the new fields: Replace a student's subjects or tags, update notes, and clear optional tags or notes. Omitted fields remain unchanged.
- Filter students: Use
list s/Maths s/Physicsorlist t/Needs revision. Each filter matches any supplied complete subject or tag, ignoring case. Subject and tag filters cannot be combined in the same command. - Archive and restore profiles: Use
archive s/FULL NAMEandunarchive s/FULL NAMEwithout deleting student data. Uselist -archivedto show archived students only, andlistto return to active students. - Improved name search:
find KEYWORD [MORE_KEYWORDS]searches active students using case-insensitive, whole-word matching. It matches any supplied keyword and gives clearer result feedback. - Fee summary:
list -summaryreports total and paid counts for the displayed active students. It also works with either subject or tag filters. - CSV export:
exportsaves all contacts, including archived students, to a timestamped UTF-8 CSV file. Exported fields include subjects, tags, notes and archive status. - Refreshed interface: A pixel-styled theme, compact student cards, subject labels and a total/paid summary. Hover over a card for profile details, including tags and notes, or use
view INDEX.
Product in action
Student overview
The refreshed interface showing five active students and the total/paid summary.
Filtering by subject
list s/Maths shows Amy Tan and Chloe Lee, the two active students taking Maths.
Viewing archived students
list -archived shows Ryan Goh separately from the active list.
The screenshots use fictional demonstration profiles.
Getting started
- Install Java 25 using the course-prescribed Java distribution for your operating system.
- Download
TuteeDex.jarfrom this release and place it in a new folder for alpha testing. - Open a terminal in that folder and run
java -jar TuteeDex.jar. - Run
listto display active students, then enter commands in the command box.
Example:
add n/Amy Tan p/91234567 a/Block 12, Clementi Avenue 3 d/10-Aug s/Maths s/Physics o/120 t/Needs revision notes/Practise algebra
view 1
list s/Maths
See the User Guide for command syntax and validation rules.
Alpha limitations
- The initial list on startup may include archived profiles. Run
listto show active students only, orlist -archivedto show archived students only. - Start dates are checked for the
DD-MMMformat, but calendar validity is not checked. list -archivedis a standalone option and cannot be combined with subject/tag filters or-summary.- Outstanding amounts are recorded manually. This release does not process payments or maintain a payment history.
- Back up existing data before testing. Data from before the student-profile schema change remains incompatible.
Full changelog: v1.3...v1.4
TuteeDex v1.3
TuteeDex v1.3 is our first working MVP for private tutors to manage student profiles through a command-driven desktop interface.
What's new compared with AddressBook3
- Student profiles now contain a name, eight-digit phone number, address, tuition start date, and outstanding amount. The student profile replaces AB3's email and tag fields.
- Track outstanding amounts in SGD, displayed to two decimal places on each student card. The optional
o/field defaults to zero; negative amounts and values with more than two decimal places are rejected. - Edit any of the five profile fields using
edit INDEX .... Omitted fields retain their existing values, andedit INDEX o/0resets the balance to zero. - Use
view INDEXto display all five fields for a selected student.findsearches names, andlistrestores the full list with a contact count. - Add student profiles, then edit or delete them using indexes in the displayed list, including search results. Duplicate profiles are rejected when all five fields match; amounts are compared numerically, so
0and0.00are equivalent. - Student profile changes are saved locally and restored when the application restarts.
- The application is distributed as
TuteeDex.jar, uses the TuteeDex window title, and the Help window points to our team's User Guide.
Product in action
Student profiles and outstanding balances
Editing a student's balance
Clear feedback for duplicate profiles
Getting started
- Install Java 25 using the course-prescribed Java distribution for your operating system.
- Download
TuteeDex.jarfrom this release and place it in a new folder. - Open a terminal in that folder and run
java -jar TuteeDex.jar.
See the User Guide for command syntax and examples.
MVP limitations
- Start dates are checked for the
DD-MMMformat; calendar validity is not checked. - Data from before the student-profile schema change is incompatible. Keep a backup of older data and start this version in a new folder.
- This version records outstanding amounts; it does not process payments.






