---
layout: page
title: User Guide
---

# SunRez v1.2 User Guide
SunRez is a **desktop app for managing student housing services, optimized for use via a Command Line Interface** (CLI). SunRez keeps track of maintenance issues, student and room records and offers efficient management for users who can type fast.

- [Quick start](#quick-start)
- [Features](#features)
* [Show help : `help`](#show-help--help)
* [Add a resident : `radd`](#add-a-resident--radd)
* [List all residents : `rlist`](#list-all-residents--rlist)
* [Find residents : `rfind`](#find-residents--rfind)
* [Edit a resident record : `redit`](#edit-a-resident-record--redit)
* [Delete a resident : `rdel`](#delete-a-resident--rdel)
* [Add a room : `oadd`](#add-a-room--oadd)
* [List all rooms : `olist`](#list-all-rooms--olist)
* [Find rooms : `ofind`](#find-rooms--ofind)
* [Edit a room record : `oedit`](#edit-a-room-record----oedit)
* [Delete a room : `odel`](#delete-a-room----odel)
* [Add an open issue : `iadd`](#add-an-open-issue--iadd)
* [List all issues : `ilist`](#list-all-issues--ilist)
* [Find issues : `ifind`](#find-issues--ifind)
* [Edit an issue record : `iedit`](#edit-an-issue-record--iedit)
* [Close an issue : `iclose`](#close-an-issue--iclose)
* [Delete an issue : `idel`](#delete-an-issue--idel)
* [Saving the data](#saving-the-data)
* [Editing the data file](#editing-the-data-file)
- [FAQ](#faq)
- [Command summary](#command-summary)

--------------------------------------------------------------------------------------------------------------------

## Quick start

1. Ensure you have Java `11` or above installed in your Computer.

1. Download the latest `sunrez.jar` from [here](https://github.com/AY2021S2-CS2103-T14-1/tp/releases).

1. Copy the file to the folder you want to use as the _home folder_ for your SunRez.

1. Double-click the file to start the app. A GUI should appear in a few seconds. Note how the app contains some sample data.

3. Type a 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:

* **`rlist`** : Lists all residents.

* **`radd`**`n/Joseph Tan p/84666774 e/[e-mail] y/2` : Adds a resident named `Joseph Tan` with phone number `84666774`, email `[e-mail]`, and as a 2nd year student.

* **`rdel`**`3` : Deletes the 3rd resident shown in the current resident list.

* **`exit`** : Exits the app.

1. Refer to the [Features](#features) below for details of each command.

--------------------------------------------------------------------------------------------------------------------

## Features

<div markdown="block" class="alert alert-info">

**:information_source: Notes about the command format:**<br>

* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
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.<br>
e.g `d/DESCRIPTION [t/TIMESTAMP]` can be used as `d/Broken chair t/2020-03-23` or as `d/Broken chair`.

* Parameters can be in any order.<br>
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.

* If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.<br>
e.g. if you specify `n/John Doe n/Jane Doe`, only `n/Jane Doe` will be taken.

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

</div>

### Show help : `help`

Shows a message explaining how to access the help page.

Format: `help`

### Add a resident : `radd`

Adds a resident to the housing management system.

Format: `radd n/NAME p/PHONE_NUMBER e/EMAIL y/YEAR`

Examples:

* `radd n/Joseph Tan p/84666774 e/[e-mail] y/2` Adds a resident named `Joseph Tan` with phone number `84666774`, email `[e-mail]`, and as a 2nd year student.
* `radd n/John Doe p/91234567 e/[e-mail] y/3` Adds a resident named `John Doe` with phone number `91234567`, email `[e-mail]`, and as a 3rd year student.

### List all residents : `rlist`

Shows a list of all residents in the system sorted by alphabetical order.

Format: `rlist`

### Find residents : `rfind`

Finds residents whose names contain any of the given keywords.

Format: `rfind 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.
* Residents matching at least one keyword will be returned (i.e. OR search). e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`

Examples:

* `rfind john` returns `Johnny` and `John Doe`.
* `rfind alex david` returns `Alex Yeoh`, `Alexander Graham`, and `David Li`.

### Edit a resident record : `redit`

Edits an existing resident record.

Format: `redit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL]`

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

Example:

* `redit 1 p/91234567 e/[e-mail]` Edits the phone number and email address of the 1st resident to be `91234567` and `[e-mail]` respectively.

### Delete a resident : `rdel`

Deletes a resident record at the specified index.

Format: `rdel INDEX`

Example:

* `rdel 1` Deletes the 1st resident in the resident list.

### Add a room : `oadd`

Adds a room to the housing management system.

Format: `oadd n/ROOM_NO t/TYPE o/OCCUPY_STATUS [g/TAG]`

Example:

* `oadd n/10-112 t/single_no_ac o/Occupied g/SHN` Adds a room numbered `10-112` of type `single_no_ac` with the tag `SHN` and occupy status `Occupied`.

### List all rooms : `olist`

Shows a list of all rooms in the system sorted by room number.

Format: `olist`

### Find rooms : `ofind`

Finds rooms that contain any of the given keywords.

Format: `ofind KEYWORD [MORE_KEYWORDS]`

* The search matches any part of the room number. e.g `10` will match `10-111` and `14-101`
* The order of the keywords does not matter. e.g. `11- 10-` will match `10-100`, `10-101`, `11-100`, and `11-101`.
* Only the room number is searched.
* Rooms matching at least one keyword will be returned (i.e. OR search). e.g. `10 20` will return `10-100`, `11-120`

Examples:

* `ofind 10-` returns `10-100`, `10-101`, and `10-102`.
* `ofind 10- 15-` returns `10-100`, `10-101`, `15-100`, and`15-101`.
* `ofind 10` returns `09-100`, `09-110`, `10-100`, and `10-101`.

### Edit a room record : `oedit`

Edits an existing room record.

Format: `oedit INDEX [n/ROOM_NO] [t/TYPE] [o/OCCUPY_STATUS] [g/TAG]`

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

Example:

* `oedit 1 o/Occupied g/SHN` Edits the status of the 1st room and tag to be `Occupied` and `SHN` respectively.

### Delete a room : `odel`

Deletes a room at the specified index.

Format: `odel INDEX`

Examples:

* `odel 1` Deletes the 1st room in the room list.

### Add an open issue : `iadd`

Adds an issue to the housing management system.

Format: `iadd r/ROOM_NO d/DESCRIPTION [t/TIMESTAMP] [s/STATUS] [c/CATEGORY]`

Example:

* `iadd r/10-100 d/Broken light c/Furniture` Creates an issue for room number `10-100` with description `Broken light` under the category `Furniture`.

### List all issues : `ilist`

Shows a list of all issues in the system sorted by timestamp.

Format: `ilist`

### Find issues : `ifind`

Finds issues that contain any of the given keywords.

Format: `ifind KEYWORD [MORE_KEYWORDS]`

* The search is case-insensitive. e.g `broken` will match `Broken`
* The order of the keywords does not matter. e.g. `Broken light` will match `light broken`
* Only the description is searched.
* Issues matching at least one keyword will be returned (i.e. OR search). e.g. `Broken window` will return `Broken light`, `Dirty window`, and `Broken window`.

Examples:

* `ifind chair` returns `Broken chair` and `Chair missing wheel`.
* `ifind wardrobe table` returns `Wardrobe door broke`, `Table unstable`, and `Table stuck in wardrobe`.

### Edit an issue record : `iedit`

Edits an existing issue record.

Format: `iedit INDEX [r/ROOM] [d/DESCRIPTION] [t/TIMESTAMP] [s/STATUS] [c/CATEGORY]`

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

Example:

* `iedit 1 r/20-109 s/Closed` Edits the room number and status of the 1st issue to be `20-109` and `Closed` respectively.

### Close an issue : `iclose`

Marks as closed an issue at the specified index.

Format: `iclose INDEX`

Example:

* `iclose 1` Closes the 1st issue.

### Delete an issue : `idel`

Deletes an issues at the specified index.

Format: `idel INDEX`

Example:

* `idel 1` Deletes the 1st issue.

### Saving the data

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

### Editing the data file

SunRez data is saved as a JSON file `[JAR file location]/data/sunrez.json`. Advanced users are welcome to update data directly by editing that data file.

<div markdown="span" class="alert alert-warning"> <i>Caution</i>: If your changes to the data file makes its format invalid, SunRez will discard all data and start with an empty data file at the next run.
</div>

--------------------------------------------------------------------------------------------------------------------

## FAQ

**Q**: How do I transfer my data to another Computer?<br>
**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 SunRez home folder.

--------------------------------------------------------------------------------------------------------------------

## Command summary

Action | Format, Examples
--------|------------------
**Show help** | `help`
**Add a resident** | `radd n/NAME p/PHONE_NUMBER e/EMAIL y/YEAR` <br> e.g. `radd n/Joseph Tan p/84666774 e/[e-mail] y/2`
**List all residents** | `rlist`
**Find residents** | `rfind KEYWORD [MORE_KEYWORDS]` <br> e.g. `rfind bob bobby`
**Edit a resident record** | `redit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL]` <br> e.g. `redit 1 p/91234567 e/[e-mail]`
**Delete a resident** | `rdel INDEX` <br> e.g. `rdel 1`
**Add a room** | `oadd n/ROOM_NO t/TYPE o/OCCUPY_STATUS [g/TAG]` <br> e.g. `oadd n/17-101 t/single_no_ac o/Occupied g/SHN`
**List all rooms** | `olist`
**Find rooms** | `ofind KEYWORD [MORE_KEYWORDS]` <br> e.g. `ofind 10- 15-`
**Edit a room record** | `oedit INDEX [n/ROOM_NO] [t/TYPE] [g/TAG] [o/OCCUPY_STATUS]` <br> e.g. `oedit 1 o/Occupied`
**Delete a room** | `odel INDEX` <br> e.g. `odel 1`
**Add an open issue** | `iadd r/ROOM_NO d/DESCRIPTION [t/TIMESTAMP] [s/STATUS] [c/CATEGORY]` <br> e.g. `iadd r/10-100 d/Broken light c/Furniture`
**List all issues** | `ilist`
**Find issues** | `ifind KEYWORD [MORE_KEYWORDS]` <br> e.g. `ifind wardrobe table`
**Edit an issue record** | `iedit INDEX [r/ROOM] [d/DESCRIPTION] [t/TIMESTAMP] [s/STATUS] [c/CATEGORY]` <br> e.g. `iedit 1 r/20-109 s/Closed`
**Close an issue** | `iclose INDEX` <br> e.g. `iclose 1`
**Delete an issue** | `idel INDEX` <br> e.g. `idel 1`
**Exit the app** | `exit`