Update README.md (#63)

* Update README.md * Update README.md * Update README.md
anavilohia · Dec 5, 2024 · 9ddd769 · 9ddd769
1 parent bf38622
commit 9ddd769
Showing 1 changed file with 31 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -12,9 +12,9 @@ Innov8
 
 ## Team members
 
-Anavi Lohia (al3750)
-Jane Lim (jl6094)
-Jonghyun Lee (jl6509)
+Anavi Lohia (al3750) \
+Jane Lim (jl6094) \
+Jonghyun Lee (jl6509) \
 Jungyun Kim (jk4661)
 
 Team member conrtibutions can be found on the JIRA project at this link:
@@ -45,8 +45,6 @@ To set up and run the repository after installation, you can use the following c
 By default, the service operates in local mode, saving and loading files from local storage.
 If you would like to use Google Cloud Storage (GCS), you can enable GCS operations by passing the `--useGCS` flag as noted below.
 But please note that if you plan to run the service with GCS enabled, you need to install and set up [Google Cloud CLI](https://cloud.google.com/sdk/docs/install-sdk).
-`<br/>`
-`<br/>`
 
 ### Switch to code directory from root
 
@@ -299,21 +297,22 @@ The following tools were used in the development and modification of this reposi
 
   * Enabled via the "Actions" tab on GitHub, it runs automatically for every pull request and commit to 'main' branch
   * It runs a Maven build to make sure the code builds on branch 'main'
+  * Link to CI reports: https://github.com/anavilohia/Innov8/actions/workflows/maven.yml
 * GitHub Branch Protection Rules
 
   * Requires at least one review approval for every pull request into 'main' branch
   * Requires a successful build
 * Checkstyle
 
   * Checks that the code follows style guidelines, generating warnings or errors as needed
-  * This runs as part of the CI pipeline; the most recent report can be found in the Actions tab under the most recent workflow run > Artifacts > ci-reports
+  * This runs as part of the CI pipeline; the most recent report can be found by clicking the above CI reports link and clicking the most recent workflow run > Artifacts > ci-reports (this is also included in the reports folder in the root of the repo)
   * It can also be run using the "Checkstyle-IDEA" plugin for IntelliJ
   * Most recent checkstyle results (Dec 4, 2024)
     <img width="647" alt="image" src="https://github.com/user-attachments/assets/68215630-c372-432f-966f-b8bb20b9e6f3">
 * PMD
 
   * Performs static analysis of the Java code, generating errors and warnings as needed
-  * This runs as part of the CI pipeline; the most recent report can be found in the Actions tab under the most recent workflow run > Artifacts > ci-reports
+  * This runs as part of the CI pipeline; the most recent report can be found by clicking the above CI reports link and clicking the most recent workflow run > Artifacts > ci-reports (this is also included in the reports folder in the root of the repo)
   * The current code includes the following rulesets as specified in pom.xml:
     ```
     <ruleset>/category/java/errorprone.xml</ruleset>
@@ -324,57 +323,56 @@ The following tools were used in the development and modification of this reposi
 * JUnit
 
   * JUnit tests get run automatically as part of the CI pipeline
-  * They can also be manually run using the code specified in above sections
+  * They can also be manually run using the code specified in the above sections
 * JaCoCo
 
   * JaCoCo generates code test coverage reports such as branch analysis
-  * This runs as part of the CI pipeline; the most recent report can be found in the Actions tab under the most recent workflow run > Artifacts > ci-reports
+  * This runs as part of the CI pipeline; the most recent report can be found by clicking the above CI reports link and clicking the most recent workflow run > Artifacts > ci-reports (this is also included in the reports folder in the root of the repo)
   * Most recent jacoco report with 86% overall branch coverage
     <img width="1457" alt="image" src="https://github.com/user-attachments/assets/12c55acf-e826-4fc2-8310-42d123b7825d">
 * Postman
-
+  
   * Used for testing that the API and its endpoints work as intended
   * Ran the application locally in setup mode (please refer to the above build and run guide) to generate example data for testing purposes
   * API Endpoint Test Results for demoClientId
     * `/index`
-      `<img width="1008" alt="image" src="https://github.com/user-attachments/assets/3e7b8a00-9fe4-4e55-800d-6b7ab86e009e">`
+      <img width="1008" alt="image" src="https://github.com/user-attachments/assets/3e7b8a00-9fe4-4e55-800d-6b7ab86e009e">
     * `/retrieveTasks?clientId=demoClientId`
-      `<img width="1010" alt="image" src="https://github.com/user-attachments/assets/bd7d730e-b406-425c-a9b4-6f3665578a77">`
+      <img width="1010" alt="image" src="https://github.com/user-attachments/assets/bd7d730e-b406-425c-a9b4-6f3665578a77">
     * `/retrieveTask?taskId=1&clientId=demoClientId`
-      `<img width="1006" alt="image" src="https://github.com/user-attachments/assets/e65d324b-284b-44f3-b561-cce08db8c5de">`
+      <img width="1006" alt="image" src="https://github.com/user-attachments/assets/e65d324b-284b-44f3-b561-cce08db8c5de">
     * `/addTask?taskName=checkup&priority=4&startTime=2024-12-17 11:30&endTime=2024-12-17 12:00&latitude=40.83&longitude=-73.91&clientId=demoClientId`
-      `<img width="1006" alt="image" src="https://github.com/user-attachments/assets/76719d56-4b0a-4184-90f4-dcdbc31bdbd2">`
-      `<img width="1007" alt="image" src="https://github.com/user-attachments/assets/23384dc9-929c-470f-98ff-78e2cc7931db">`
+      <img width="1006" alt="image" src="https://github.com/user-attachments/assets/76719d56-4b0a-4184-90f4-dcdbc31bdbd2">
+      <img width="1007" alt="image" src="https://github.com/user-attachments/assets/23384dc9-929c-470f-98ff-78e2cc7931db">
     * `/modifyResourceType?taskId=4&typeName=Nurse&quantity=1&clientId=demoClientId`
-      `<img width="1007" alt="image" src="https://github.com/user-attachments/assets/03d7fd56-ed0b-4db2-9843-2683ca1ea5cb">`
-      `<img width="1006" alt="image" src="https://github.com/user-attachments/assets/ef79cc12-ab82-43c3-be71-8799048b3e3b">`
+      <img width="1007" alt="image" src="https://github.com/user-attachments/assets/03d7fd56-ed0b-4db2-9843-2683ca1ea5cb">
+      <img width="1006" alt="image" src="https://github.com/user-attachments/assets/ef79cc12-ab82-43c3-be71-8799048b3e3b">
     * `/deleteTask?taskId=4&clientId=demoClientId`
-      `<img width="1006" alt="image" src="https://github.com/user-attachments/assets/e178c21e-81f8-44d1-b869-6ab5365112a0">`
-      `<img width="1006" alt="image" src="https://github.com/user-attachments/assets/baad90ca-523b-4110-b0f3-a57415931718">`
+      <img width="1006" alt="image" src="https://github.com/user-attachments/assets/e178c21e-81f8-44d1-b869-6ab5365112a0">
+      <img width="1006" alt="image" src="https://github.com/user-attachments/assets/baad90ca-523b-4110-b0f3-a57415931718">
     * `/retrieveResourceTypes?clientId=demoClientId`
-      `<img width="999" alt="image" src="https://github.com/user-attachments/assets/4074b6f7-051e-4a55-af69-38de1e1b2310">`
+      <img width="999" alt="image" src="https://github.com/user-attachments/assets/4074b6f7-051e-4a55-af69-38de1e1b2310">
     * `/addResourceType?typeName=SurgeryRoom&totalUnits=10&latitude=40.84&longitude=-73.94&clientId=demoClientId`
-      `<img width="1004" alt="image" src="https://github.com/user-attachments/assets/c35f0129-4368-4205-b6e3-5860f4fcff02">`
-      `<img width="1006" alt="image" src="https://github.com/user-attachments/assets/6e4ebc0e-3a32-4909-8c45-a54b06a3318a">`
+      <img width="1004" alt="image" src="https://github.com/user-attachments/assets/c35f0129-4368-4205-b6e3-5860f4fcff02">
+      <img width="1006" alt="image" src="https://github.com/user-attachments/assets/6e4ebc0e-3a32-4909-8c45-a54b06a3318a">
     * `/deleteResourceType?typeName=SurgeryRoom&clientId=demoClientId`
-      `<img width="1007" alt="image" src="https://github.com/user-attachments/assets/347765df-ec6d-40ea-84b8-2e5a49b86b7d">`
-      `<img width="1004" alt="image" src="https://github.com/user-attachments/assets/1ba27ba6-592f-42dd-86cc-e3e7318478a2">`
+      <img width="1007" alt="image" src="https://github.com/user-attachments/assets/347765df-ec6d-40ea-84b8-2e5a49b86b7d">
+      <img width="1004" alt="image" src="https://github.com/user-attachments/assets/1ba27ba6-592f-42dd-86cc-e3e7318478a2">
     * `/retrieveSchedule?clientId=demoClientId`
-      `<img width="1008" alt="image" src="https://github.com/user-attachments/assets/7468aab0-b879-41ef-88df-f9ff2281a5fb">`
+      <img width="1008" alt="image" src="https://github.com/user-attachments/assets/7468aab0-b879-41ef-88df-f9ff2281a5fb">
     * `/updateSchedule?maxDistance=10&clientId=demoClientId`
-      `<img width="997" alt="image" src="https://github.com/user-attachments/assets/eeb16bd1-1118-4832-b043-1297f4a77f03">`
-      `<img width="1003" alt="image" src="https://github.com/user-attachments/assets/012e4d77-48cf-4476-b024-6af5bae90983">`
+      <img width="997" alt="image" src="https://github.com/user-attachments/assets/eeb16bd1-1118-4832-b043-1297f4a77f03">
+      <img width="1003" alt="image" src="https://github.com/user-attachments/assets/012e4d77-48cf-4476-b024-6af5bae90983">
     * `/unscheduleTask?taskId=1&clientId=demoClientId`
-      `<img width="1008" alt="image" src="https://github.com/user-attachments/assets/d6d55857-e953-4b52-801c-6c970e8de405">`
-      `<img width="1003" alt="image" src="https://github.com/user-attachments/assets/6b5d95a9-d5d5-42fa-9e17-34446b73926b">`
+      <img width="1008" alt="image" src="https://github.com/user-attachments/assets/d6d55857-e953-4b52-801c-6c970e8de405">
+      <img width="1003" alt="image" src="https://github.com/user-attachments/assets/6b5d95a9-d5d5-42fa-9e17-34446b73926b">
   * Note that the database for a different clientId is unaffected by the above API calls. Below are a few results of calling the APIs for another client.
     * `/retrieveTasks?clientId=otherClientId`
     * The database for this clientId is empty so you get the Tasks Not Found
-      `<img width="1003" alt="image" src="https://github.com/user-attachments/assets/c95e640b-1041-44fc-b611-5aa8bef41f8d">`
+      <img width="1003" alt="image" src="https://github.com/user-attachments/assets/c95e640b-1041-44fc-b611-5aa8bef41f8d">
     * `/retrieveResourceTypes?clientId=otherClientId`
     * The database for this clientId is empty so you get the ResourceTypes Not Found
-      `<img width="1003" alt="image" src="https://github.com/user-attachments/assets/69e6d72c-f8ce-4269-a270-492a146b8acb">`
-
----
+      <img width="1003" alt="image" src="https://github.com/user-attachments/assets/69e6d72c-f8ce-4269-a270-492a146b8acb">
+---------------------------------------------
 
 `citations.txt` is located at root level of this repository, it specifies urls for all resources used as reference in the development of this repository