@openmrs/esm-form-builder-app 1.0.1-pre.144 → 1.0.1-pre.146
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,35 @@
|
|
|
1
1
|
# OpenMRS ESM Form Builder App
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The Form Builder is a widget used to create OpenMRS form schemas. It enables users to both create new schemas and edit existing ones. It provides an embedded code editor that accepts JSON code. It also provides an interactive editor where users can construct a schema interactively without writing code.
|
|
4
4
|
|
|
5
5
|
## Form Builder User Guide
|
|
6
|
+
|
|
6
7
|
* See the thorough User Guide for the Form Builder here: https://ampath-forms.vercel.app/docs/quickstart
|
|
7
8
|
* Prerequisites & dependencies are covered here: https://ampath-forms.vercel.app/docs/developer-guide/run-form-engine-in-openmrs3#prerequisites
|
|
8
9
|
|
|
9
10
|
## Running this code
|
|
11
|
+
Under the hood, the Form Builder uses the [OHRI form engine](https://www.npmjs.com/package/@ohri/openmrs-ohri-form-engine-lib) to render a visual representation of your schema. This visual preview gets progressively updated as you build your schema. When done building, you can save your schema to an OpenMRS server. You can also publish your schema to make it available to your frontend.
|
|
12
|
+
|
|
13
|
+
## Local development
|
|
10
14
|
|
|
11
15
|
```sh
|
|
12
|
-
yarn #
|
|
13
|
-
yarn start #
|
|
16
|
+
yarn # Installs dependencies
|
|
17
|
+
yarn start # Launches a dev server
|
|
14
18
|
```
|
|
15
|
-
Once it is running, a browser window
|
|
16
|
-
should open with the OpenMRS 3 application. Log in and then navigate to
|
|
17
|
-
`/openmrs/spa/form-builder`.
|
|
18
19
|
|
|
20
|
+
Once the dev server launches, log in and select a location. You will get redirected to the home page. Once there, you can either:
|
|
21
|
+
|
|
22
|
+
- Click the App Switcher icon in the top right corner and then click `Form Builder` to launch the app.
|
|
23
|
+
- Manually navigate to the `/openmrs/spa/form-builder` URL.
|
|
24
|
+
|
|
25
|
+
## Building
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
yarn build
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Running tests
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
yarn test
|
|
35
|
+
```
|