forked from nus-cs2103-AY2324S2/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16 from felixchanyy/branch-readme
Update README page
- Loading branch information
Showing
2 changed files
with
17 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,20 @@ | ||
[![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/AY2324S2-CS2103-F09-1/tp/graph/badge.svg?token=NB86I9H23Z)](https://codecov.io/gh/AY2324S2-CS2103-F09-1/tp) | ||
[![CI Status](https://github.com/AY2324S2-CS2103-F09-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) [![codecov](https://codecov.io/gh/AY2324S2-CS2103-F09-1/tp/graph/badge.svg?token=NB86I9H23Z)](https://codecov.io/gh/AY2324S2-CS2103-F09-1/tp) | ||
|
||
![Ui](docs/images/Ui.png) | ||
|
||
* This is **a sample project for Software Engineering (SE) students**.<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. | ||
## About the app | ||
|
||
EstateEase simplifies residential property management for real estate listing agents in Singapore. | ||
|
||
### Key Features: | ||
* With intuitive tools for listing and client communication, the app is tailored for efficiency. | ||
* Agents can quickly access contacts and prioritize them, ensuring swift connections with clients. | ||
|
||
### Example Usages: | ||
* Allows real estate agents to add and delete client information. | ||
* Allows real estate agents to prioritize client contacts for efficient communication | ||
* Allows real estate agents to load and save the list using JSON file | ||
|
||
## Acknowledgements | ||
This project is based on the AddressBook-Level3 project created by the | ||
[SE-EDU initiative](https://se-education.org). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.