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.

Sign up for GitHub

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.md #15

Merged
merged 1 commit into from
Mar 2, 2024
Merged

Update READme.md #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 27 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@
[![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/AY2324S2-CS2103T-W12-4/tp/actions)
[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W12-4/tp/graph/badge.svg?token=F5OYT9DURR)](https://codecov.io/gh/AY2324S2-CS2103T-W12-4/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.
# ConnectCare
ConnectCare is a client management application designed for social workers. It streamlines client case management, focusing on efficient scheduling and visit tracking. The application aims to optimize scheduling, manage client goals, and ensure effective collaboration among social workers.

## Table of contents
- [Features](#features)
- [Installation and Usage](#installation-and-usage)
- [User Stories](#user-stories)
- [Acknowledgements](#acknowledgements)
- [License](#license)

## Features
- **Client Profile Management:** Create, update, and categorize client profiles effectively.
- **Search:** Search for clients based on keywords and tags.

## Installation and Usage
Prerequisites: JDK 11, update Intellij to the most recent version.
1. Clone the repository
2. Configure the project to use JDK 11 (not other versions) as explained in here.
In the same dialog, set the Project language level field to the SDK default option.
3. After that, open the Gradle tab and execute the gradle command `gradle run`

## Acknowledgements
- This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

## License
ConnectCare is licensed under the [MIT License](LICENSE).
Loading