[CS2103T-W12-4] Connect Care

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: MarkBind Action
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Build & Deploy MarkBind site
+        uses: MarkBind/markbind-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          rootDirectory: './docs'
+          baseUrl: '/tp' # assuming your repo name is tp
+          version: '^5.2.0'

.github/workflows/gradle.yml

@@ -38,8 +38,17 @@ jobs:
       - name: Build and check with Gradle
         run: ./gradlew check coverage
 
-      - name: Upload coverage reports to Codecov
+      - name: Validate codecov.yml
         if: runner.os == 'Linux'
-        uses: codecov/codecov-action@v3
+        run: curl --data-binary @codecov.yml https://codecov.io/validate
+
+      - name: Upload coverage reports to Codecov
         env:
+          slug: AY2324S2-CS2103T-W12-4/tp
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        if: runner.os == 'Linux'
+        uses: codecov/[email protected]
+        with:
+          verbose: true
+          fail_ci_if_error: false
+

.gitignore

@@ -21,3 +21,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/_markbind/logs/

README.md

@@ -1,14 +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).

build.gradle

@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveFileName = 'addressbook.jar'
+    archiveFileName = 'connectcare.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

codecov.yml

@@ -0,0 +1,15 @@
+# For more configuration details:
+# https://docs.codecov.io/docs/codecov-yaml
+
+# Coverage Config
+# ----------------------
+coverage:
+  range: 70..90
+  round: down
+  precision: 4
+
+# Ignoring Paths and Files
+# --------------
+ignore:
+  - "src/main/java/seedu/address/ui"
+  - "src/main/java/seedu/address/MainApp.java"

docs/.gitignore

@@ -0,0 +1,23 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+_markbind/logs/
+
+# Dependency directories
+node_modules/
+
+# Production build files (change if you output the build to a different directory)
+_site/
+
+# Env
+.env
+.env.local
+
+# IDE configs
+.vscode/
+.idea/*
+*.iml

docs/AboutUs.md

@@ -1,59 +1,76 @@
 ---
-layout: page
-title: About Us
+  layout: default.md
+  title: "About Us"
 ---
 
-We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
+# About Us
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
+We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg). 
+We are passionate and deeply committed to using technology to create positive social impact.
+We hope to alleviate some of the burdens social workers carry by streamlining their workflow 
+and simplifying administrative tasks. Our goal is to free up valuable time and energy for 
+social workers to focus on the most important aspects of their work.
+
+
+You can reach us at the email `connect_care[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Damith C. Rajapakse
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/damithc.png" width="200px">
 
 [[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/damithc)]
+[[portfolio](http://www.comp.nus.edu.sg/~damithch)]
 
 * Role: Project Advisor
 
-### Jane Doe
+### P J Anthony
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/pjanthony2001.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/pjanthony2001)]
+[[portfolio](team/anthony.md)]
 
 * Role: Team Lead
-* Responsibilities: UI
+* Responsibilities: Manages the project
+
+### Au Jun Ming Jeremiah
+
+<img src="images/jolonauh.png" width="200px">
+
+[[github](http://github.com/jolonauh)]
+[[portfolio](team/jeremiah.md)]
+
+* Role: Developer
+* Responsibilities: Testing
 
-### Johnny Doe
+### Rishit Khandelwal
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/rishit02.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/rishit02)] [[portfolio](team/rishit.md)]
 
 * Role: Developer
-* Responsibilities: Data
+* Responsibilities: Code Quality
 
-### Jean Doe
+### Eliot Lee Leong Wern
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/eliotlee68.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/eliotlee68)]
+[[portfolio](team/eliot.md)]
 
 * Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Deliverables and deadlines
 
-### James Doe
+### Tejas Sadasivam
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/tejas-1405.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/tejas-1405)]
+[[portfolio](team/tejas.md)]
 
 * Role: Developer
-* Responsibilities: UI
+* Responsibilities: Documentation

docs/Configuration.md

@@ -1,6 +1,8 @@
 ---
-layout: page
-title: Configuration guide
+  layout: default.md
+  title: "Configuration guide"
 ---
 
+# Configuration guide
+
 Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).

docs/DevOps.md

@@ -1,12 +1,15 @@
 ---
-layout: page
-title: DevOps guide
+  layout: default.md
+  title: "DevOps guide"
+  pageNav: 3
 ---
 
-* Table of Contents
-{:toc}
+# DevOps guide
 
---------------------------------------------------------------------------------------------------------------------
+<!-- * Table of Contents -->
+<page-nav-print />
+
+<!-- -------------------------------------------------------------------------------------------------------------------- -->
 
 ## Build automation