Skip to content

Commit

Permalink
Fix checkstyle trailing whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
jessica2828 committed Nov 7, 2024
1 parent 5764620 commit 773bf77
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,31 @@

# EduContacts

**EduContacts** is a desktop application designed for **tertiary teachers and educators** to manage contacts with
**EduContacts** is a desktop application designed for **tertiary teachers and educators** to manage contacts with
students, parents, and faculty across multiple classes or educational years.

- It is optimized for those who prefer to work with a **Command Line Interface** (CLI) while still having the
- It is optimized for those who prefer to work with a **Command Line Interface** (CLI) while still having the
- benefits of a **Graphical User Interface** (GUI).
- It helps educators keep communication organized, track academic progress, and support parent-teacher interactions
- It helps educators keep communication organized, track academic progress, and support parent-teacher interactions
- efficiently, often across large groups.

## Value Proposition

An address book tailored for educators simplifies student and parent contact management, enhances communication
An address book tailored for educators simplifies student and parent contact management, enhances communication
tracking, and integrates progress reports, helping teachers save time and foster effective collaboration across the school community.

## Features

- **Class/Group-Based Contact Management**: Organize contacts by class, subject, or school year for easy access.
- **Parent-Teacher Communication Tracking**: Keep a history of messages or meetings with parents and faculty.
- **Student Progress and Grade Tracking**: Link contact information with student records and academic performance.
- **Event Scheduling and Reminders**: Integrate with school calendars to manage parent-teacher meetings,
- **Event Scheduling and Reminders**: Integrate with school calendars to manage parent-teacher meetings,
report deadlines, or school events.
- **Group Messaging**: Enable teachers to send messages to an entire class or group of parents at once,
- **Group Messaging**: Enable teachers to send messages to an entire class or group of parents at once,
streamlining communication.
- **Custom Fields**: Add notes for individual students (e.g., learning accommodations,
- **Custom Fields**: Add notes for individual students (e.g., learning accommodations,
behavioral issues, or special needs).
- **Integration with School Management Systems**: Sync with platforms like Google Classroom or
- **Integration with School Management Systems**: Sync with platforms like Google Classroom or
school LMS (Learning Management Systems).

## Getting Started
Expand Down
22 changes: 11 additions & 11 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ The **API** of this component is specified in [`Ui.java`](https://github.com/se-

<puml src="diagrams/UiClassDiagram.puml" alt="Structure of the UI Component"/>

The UI is managed by the `UiManager` class, which serves as the main controller for managing the UI in EduContacts.
The UI is managed by the `UiManager` class, which serves as the main controller for managing the UI in EduContacts.
It serves as the interface layer between the application's backend logic and the JavaFX UI components, ensuring a smooth
and consistent user experience.

The UI consists of a `MainWindow` that is made up of the following parts:
The UI consists of a `MainWindow` that is made up of the following parts:
* `CommandBox`
* Where the user types in his desired command
* `ResultDisplay`
Expand All @@ -84,17 +84,17 @@ The UI consists of a `MainWindow` that is made up of the following parts:
* The panel which holds the list of persons in EduContacts, each person represented by a `PersonCard`
* `StatusBarFooter`
* Designed to show the save location of EduContacts' data
* `PersonDetails`
* `PersonDetails`
* A section of the UI that renders when a `FindCommand` is run, showing the resulting person's full details
* `PersonCard`
* Shows simple and brief details about a person
* `HelpWindow`
* Displayed by clicking the "Help" button at the top right hand of the screen

All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between
All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between
classes that represent parts of the visible GUI.

The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that
The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that
are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)

The `UI` component,
Expand Down Expand Up @@ -547,7 +547,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* 2b1. EduContacts overwrites the old grade with the new grade.

Use case ends.

**Use case: UC08 - Add contacts of next-of-kins of a student**

**MSS**
Expand Down Expand Up @@ -653,7 +653,7 @@ testers are expected to do more *exploratory* testing.

1. Download the jar file and copy into an empty folder.

2. Double-click the jar file.<br>
2. Double-click the jar file.<br>
Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

2. Saving window preferences
Expand Down Expand Up @@ -683,17 +683,17 @@ testers are expected to do more *exploratory* testing.
2. Deleting a person while only one person is being shown

1. Prerequisites: Filter persons using the `filter` command until only one person remains. Multiple persons in the list. Person that remains has Student ID `12345678`. One person in the list has Student ID `11111111`

2. Test case: `delete 12345678`<br>
Expected: Person with Student ID `12345678` is deleted. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. List of persons shown is now blank.

3. Test case: `delete 11111111`<br>
Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

3. Deleting a person while no persons are in the list

1. Prerequisites: Delete all persons in the list using the `clear` command.

2. Test case: `delete 12345678`<br>
Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

Expand All @@ -704,7 +704,7 @@ testers are expected to do more *exploratory* testing.
1. Dealing with missing data files

1. To simulate a missing file, in the same folder as the jar file, navigate to the `data` folder and delete the `address.json` file in the folder.

2. Launch EduContacts by double-clicking the jar file.<br>
Expected: EduContacts is populated by a set of default list of persons. A new `address.json` file will be created in the `data` folder after closing the app or executing a command.

Expand Down
30 changes: 15 additions & 15 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

# EduContacts User Guide

<br>
<br>

EduContacts is a **desktop app for Educators in Tertiary Institution to manage contacts, 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, AB3 can get your contact management tasks done faster than traditional GUI apps. For educators who may be less experienced with command-based tools, EduContacts also includes user-friendly and intuitive features and guidance, making it accessible for all users.

Expand Down Expand Up @@ -57,7 +57,7 @@ EduContacts is a **desktop app for Educators in Tertiary Institution to manage c
```bash
cd ~/Desktop/EduContacts
```

and use the following command to run the application:

```bash
Expand All @@ -71,17 +71,17 @@ EduContacts is a **desktop app for Educators in Tertiary Institution to manage c
1. 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.<br>
Some example commands you can try:

```bash
list
```bash
list
```
Lists all contacts.

```bash
```bash
add 12345678 n/John Doe p/99999999 e/[email protected] a/123 Jane Doe Road c/Computer Science t/Student
```
```
Adds a contact named `John Doe` to EduContacts.
```bash

```bash
delete 12345678
```
Deletes a student contact with StudentID `12345678`.
Expand Down Expand Up @@ -126,7 +126,7 @@ EduContacts is a **desktop app for Educators in Tertiary Institution to manage c
Shows a message explaining how to access the help page.

Format:
```bash
```bash
help
```
![help message](images/helpMessage.png)
Expand All @@ -136,7 +136,7 @@ help

Adds a person contact to the EduContacts.

Format:
Format:
```bash
add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE t/TAG
```
Expand All @@ -150,7 +150,7 @@ Examples:

Shows a list of all persons in EduContacts.

Format:
Format:
```bash
list
```
Expand Down Expand Up @@ -200,7 +200,7 @@ filter [KEYWORD_PREFIX] [MORE_KEYWORDS]
* **For filtering by Course:**
* Use prefix `c/`
* Partial matching is supported, but the first keyword must match the beginning of the course name.
* Partial matching is supported, but the first keyword must match the beginning of the course name.
e.g `Engineer` will match courses like "Engineering" but not "Civil Engineering".
<box type="tip" seamless>
Expand All @@ -210,7 +210,7 @@ filter [KEYWORD_PREFIX] [MORE_KEYWORDS]
Examples:
* ```filter n/John``` returns `john` and `John Doe`
* `filter m/CS2103T` returns a list of all students with module CS2103T.
* `filter m/CS2103T` returns a list of all students with module CS2103T.
* `filter c/Computer Science` returns a list of all students with course Computer Science.<br>
* `filter n/alex david` returns `Alex Yeoh`, `David Li`
Expand All @@ -220,7 +220,7 @@ Examples:
Deletes the specified person from EduContacts.
Format:
Format:
```bash
delete ID
```
Expand All @@ -234,7 +234,7 @@ Examples:
Clears all entries from EduContacts.
Format:
Format:
```bash
clear
```
Expand Down

0 comments on commit 773bf77

Please sign in to comment.