@openmrs/esm-fast-data-entry-app 1.0.0-pre.39 → 1.0.0-pre.48

package/.github/pull_request_template.md

@@ -0,0 +1,18 @@
+## Requirements
+
+- [ ] This PR has a title that briefly describes the work done, including the ticket number if there is a ticket.
+- [ ] My work conforms to the [OpenMRS 3.0 Styleguide](https://om.rs/styleguide).
+- [ ] My work includes tests or is validated by existing tests.
+
+## Summary
+<!-- Please describe what problems your PR addresses. -->
+
+## Screenshots
+<!-- Required if you are making UI changes. -->
+
+## Related Issue
+<!-- Paste the link to the Jira ticket here if one exists. -->
+<!-- https://issues.openmrs.org/browse/O3- -->
+
+## Other
+<!-- Anything not covered above -->

package/README.md

@@ -1,12 +1,36 @@
-
-
-# OpenMRS ESM Fast Data Entry App
-
-This repository will hold modules which make the Fast Data Entry system work.
-
-## Running this code
-
-```sh
-yarn  # to install dependencies
-yarn start  # to run the dev server
-```
+
+
+# OpenMRS ESM Fast Data Entry App
+
+The Fast Data Entry App is a module for the [OpenMRS](https://openmrs.org/) healthcare platform which allows for a natural workflow when entering many pre-recorded forms at a time. It is not meant for point-of-care workflows, but rather as a way to do retrospective data entry.
+
+## Overview
+Currently the app consists of two main parts, a Forms Page to list available forms and a Form Workflow which allows the rapid input of forms.
+
+### Forms Page
+The Forms page lists all forms able to be seen by a user, filtered by that user's permission to edit the given form. Additionally implementors are able to customize the page by creating form categories and listing the forms inside of each category. These categories can then be shown or hidden using configuration (see more [here](docs/configuring-form-categories.md)). From these lists forms are able to be opened in the Form Workflow using the 'Fill form' button.
+
+### Form Workflow
+Forms can be entered quickly with the Form Entry Workflow. This workflow depends on a state machine managed by the [FormWorkflowReducer](src/context/FormWorkflowReducer.ts).
+
+See the video below of a normal workflow.
+![Form Workflow Movie](docs/fde-workflow.mov)
+State diagram for the Form Workflow.
+![Form Workflow State Diagram](docs/form-workflow-state-diagram.png)
+
+## Running this code
+
+Clone the repo locally, then install and run using
+
+```sh
+yarn  # to install dependencies
+yarn start  # to run the dev server
+```
+
+To customize your development build pass other arguments to yarn start (which under the hood is running `npx openmrs develop`). For example to point to a backend other than [dev3](https://dev3.openmrs.org/)  specify the `--backend` option. See the full example below for running against an ICRC backend.
+
+```sh
+yarn start --importmap "https://spa-modules.nyc3.digitaloceanspaces.com/import-map.json" --backend "https://openmrs-dev-v2.test.icrc.org/" --add-cookie "MRHSession=abcdefghijklmnop012345678910" --spa-path "/ui"
+```
+
+To see more options run `npx openmrs --help`

package/docs/configuring-form-categories.md

@@ -0,0 +1,77 @@
+# Configuring Form Categories for Fast Data Entry App
+
+Configuration of which Form Categories to show, and which forms exist within each category is possible via configuration of Fast Data Entry App [config-schema](../src/config-schema.ts). For example, the configuration would setup one category "ICRC Forms" which contains one form, DASS-21. Note that formUUID must match the form UUID on the backend instance, and name is only for human readability and has no actual function.
+
+```json
+{
+  "@openmrs/esm-fast-data-entry-app": {
+    "formCategories": [
+      {
+        "name": "ICRC Forms",
+        "forms": [
+          {
+            "formUUID": "373086b0-0a65-3763-ab83-21b8867bbc6f",
+            "name": "DASS-21"
+          }
+        ]
+      }
+    ],
+    "formCategoriesToShow": [
+      "ICRC Forms"
+    ]
+  }
+}
+```
+
+This config results in the following UI:
+
+![Configure ICRC Forms](config-icrc-forms.png)
+
+Note that All Forms is always present and contains all forms the system can find.
+
+Let's see another example. The following config will load up one more form category called "Other Forms" to show, but both entries in that form category are not able to be found in the system, so no forms will render when we navigate to the "Other Forms". Also note that "Third Category of Forms" is declared, but since it's not included in the formCategoriesToShow array it is not displayed on the UI.
+
+```json
+{
+  "@openmrs/esm-fast-data-entry-app": {
+    "formCategories": [{
+        "name": "ICRC Forms",
+        "forms": [{
+          "formUUID": "373086b0-0a65-3763-ab83-21b8867bbc6f",
+          "name": "DASS-21"
+        }]
+      },
+      {
+        "name": "Other Forms",
+        "forms": [{
+            "formUUID": "00000000-0a65-3763-ab83-21b",
+            "name": "No Matching UUID"
+          },
+          {
+            "formUUID": "This isn't a UUID!",
+            "name": "Invalid UUID"
+          }
+        ]
+      },
+      {
+        "name": "Third Category of Forms",
+        "forms": [{
+          "formUUID": "ce7a6da7-444a-3038-bfc2-334ff84b86c0",
+          "name": "CRIES-8"
+        }]
+      }
+    ],
+    "formCategoriesToShow": [
+      "ICRC Forms",
+      "Other Forms"
+    ]
+  }
+}
+```
+
+This will render the following UI
+
+![Configure Other Forms](config-other-forms.png)
+
+
+For more information on using the OpenMRS configuration system see [this page](https://o3-dev.docs.openmrs.org/#/main/config)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-fast-data-entry-app",
-  "version": "1.0.0-pre.39",
+  "version": "1.0.0-pre.48",
   "license": "MPL-2.0",
   "description": "An OpenMRS 3.x microfrontend",
   "browser": "dist/openmrs-esm-fast-data-entry-app.js",