README.md

TutorMate

TutorMate is a desktop app targeted to private tuition teachers on handling tuition related matters.

It is optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, TutorMate can get your administrative tasks done faster than traditional GUI apps.

This project is based on the AddressBook-Level3 project.

Main Features

1. Student Management System: track all student details
2. Lesson Schedule: easily plan and manage lessons
3. Task Lists: keep track of tasks to be done for lessons

Quick start

1. Ensure you have Java 11 or above installed in your Computer. You can check by opening a command terminal and typing java -version.

2. Download the latest tutormate.jar from here.

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

4. Open a command terminal, navigate into the folder you put the jar file in using the change directory command cd, and use the java -jar tutormate.jar command to run the application.
   

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.
   Some example commands you can try:

   • list students : Lists all students with their name.

   • In list STUDENTS:

     • add -name Leah : Adds a student named "Leah" to the application.

     • show 3 : Shows the details of the person with the index 3 in TutorMate.

   • exit : Exits the app.

For full documentation of this project, see the following links:

• User Guide
• Developer Guide
• Github Organization