Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme, index and aboutus documentation #24

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T13-4/tp/actions)

![Ui](docs/images/Ui.png)

* This is **a sample project for Software Engineering (SE) students**.<br>
* This is **an animal foster manager for non-profit animal shelters** who currently do not have a good logistical workflow to keep track of foster families.<br>
Example usages:
* as a starting point of a course project (as opposed to writing everything from scratch)
* as a case study
* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
* It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
* It comes with a **reasonable level of user and developer documentation**.
* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
* as a streamlined workflow to **manage list of fosterers**
* provides an **intuitive** way to manage fosterers' details, such as their **availability** and **animals they can foster**
* For the detailed documentation of this project, see the **[Foster Family Product Website](https://ay2324s1-cs2103t-t13-4.github.io/tp/)**.
* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
11 changes: 5 additions & 6 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

## Project team

### John Doe
### Nicole Chiong

<img src="images/johndoe.png" width="200px">
<img src="images/butteredyakiimo.png" width="200px">

[[homepage](http://www.comp.nus.edu.sg/~damithch)]
[[github](https://github.com/johndoe)]
[[portfolio](team/johndoe.md)]
[[github](https://github.com/butteredyakiimo)]
[[portfolio](team/butteredyakiimo.md)]

* Role: Project Advisor
* Role: Deliverables and Deadlines, Code Quality

### Jane Doe

Expand Down
49 changes: 26 additions & 23 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,57 +256,60 @@ _{Explain here how the data archiving feature will be implemented}_
### Product scope

**Target user profile**:

* has a need to manage a significant number of contacts
* non-profit animal shelters who currently do not have a good logistical workflow to keep track of foster families
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps

**Value proposition**: manage contacts faster than a typical mouse/GUI driven app

**Value proposition**: low budget and efficient system that manages animal fosterers

### User stories

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

| Priority | As a …​ | I want to …​ | So that I can…​ |
| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- |
| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
| `* * *` | user | add a new person | |
| `* * *` | user | delete a person | remove entries that I no longer need |
| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident |
| `*` | user with many persons in the address book | sort persons by name | locate a person easily |
| Priority | As a …​ | I want to …​ | So that I can…​ |
| -------- |--------------------------------------------|---------------------------------------------------------------------------|------------------------------------------------------------------------|
| `* * *` | administrative staff | delete a fosterer from the list when they want to stop fostering with us | update the list to see the fosterers who are currently in our program |

*{More to be added}*

### Use cases

(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
(For all use cases below, the **System** is the `FosterFamily` and the **Actor** is the `user`, unless specified otherwise)

**Use case: Delete fosterers**

**Use case: Delete a person**
**Preconditions:** A list of fosterers is currently displayed, obtained from a list/find command.

**MSS**

1. User requests to list persons
2. AddressBook shows a list of persons
3. User requests to delete a specific person in the list
4. AddressBook deletes the person
1. User enters the fosterers to delete, who are identified by their index in the currently displayed list.
2. System deletes fosterers.
3. System shows confirmation message of fosterers successfully deleted.

Use case ends.

**Extensions**

* 2a. The list is empty.
* 1a. The list is empty.

Use case ends.

Use case ends.

* 3a. The given index is invalid.
* 1b. System detects an invalid index.
* 1b1. System requests user to enter a valid index.
* 1b2. User enters valid index.

Use case resumes at step 2.


* 3a1. AddressBook shows an error message.
* 1c. System detects an invalid command format after the `delete` command.
* 1c1. System requests for user to enter command in correct format.
* 1c2. User enters delete command in correct format.

Use case resumes at step 2.

Use case resumes at step 2.

*{More to be added}*

Expand Down
30 changes: 21 additions & 9 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,20 +127,32 @@ Examples:
* `find alex david` returns `Alex Yeoh`, `David Li`<br>
![result for 'find alex david'](images/findAlexDavidResult.png)

### Deleting a person : `delete`
### Deleting a fosterer : `delete`

Deletes the specified person from the address book.
Deletes the data entry at the index-th position of the currently displayed list.

Format: `delete INDEX`
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, …​
Parameter: `INDEX...`
* Index of a fosterer is shown in the list obtained by the `find/list` command.
* Must be a positive integer 1, 2, 3, …
* Multiple indexes are allowed for mass deletion, each index separated by a white space.
* `delete` without an index is valid if and only if there exists only one data entry in the current list.

Examples:
* `list` followed by `delete 2` deletes the 2nd person in the address book.
* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.

* `list` followed by `delete 2` deletes the 2nd fosterer in the address book
* `find Jerry` followed by `delete 1` deletes the 1st fosterer in the results of the find command
* `list` followed by `delete 1 3 7` deletes the 1st, 3rd and 7th fosterers in the address book

Expected output (success):
```agsl
Fosterers Jerry Chee, John Doe, and Mary Ann are successfully deleted!
```

Expected output (fail):
```agsl
Oops! Invalid fosterer index provided, please check again.
```
### Clearing all entries : `clear`

Clears all entries from the address book.
Expand Down
2 changes: 1 addition & 1 deletion docs/_sass/minima/_base.scss
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ table {
text-align: center;
}
.site-header:before {
content: "AB-3";
content: "Foster Family";
font-size: 32px;
}
}
Expand Down
Binary file added docs/images/butteredyakiimo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
layout: page
title: AddressBook Level-3
title: Foster Family
---

[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S1-CS2103T-T13-4/tp/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://app.codecov.io/gh/AY2324S1-CS2103T-T13-4/tp)

![Ui](images/Ui.png)

**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
**Foster Family is a desktop application for managing animal foster families.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
* If you are interested in using Foster Family, head over to the [_Quick Start_ section of the **User Guide**](https://ay2324s1-cs2103t-t13-4.github.io/tp/UserGuide.html#quick-start).
* If you are interested about developing Foster Family, the [**Developer Guide**](https://ay2324s1-cs2103t-t13-4.github.io/tp/DeveloperGuide.html) is a good place to start.


**Acknowledgements**
Expand Down
28 changes: 28 additions & 0 deletions docs/team/butteredyakiimo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: page
title: Nicole's Project Portfolio Page
---

### Project: Foster Family

This is an **animal foster manager** for **non-profit animal shelters** who currently do not have a good logistical workflow to keep track of foster families. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

Given below are my contributions to the project.

* **New Feature**:

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=butteredyakiimo&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos)

* **Project management**:

* **Enhancements to existing features**:

* **Documentation**:
* User Guide:
* Added documentation for the feature `delete`.
* Developer Guide:
* Added implementation details of the `delete` feature.

* **Community**:

* **Tools**:
Loading