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.
- See the thorough User Guide for the Form Builder here: https://ampath-forms.vercel.app/docs/quickstart
- Prerequisites & dependencies are covered here: https://ampath-forms.vercel.app/docs/developer-guide/run-form-engine-in-openmrs3#prerequisites
Under the hood, the Form Builder uses the OHRI form engine 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.
To set up environment variables for the project, follow these steps:
- Create a copy of the .env.example file by running the following command:
cp example.env .env
-
Open the newly created .env file in the root of the project.
-
Add the environment variables you need.
Note: These variables are currently only used for end-to-end tests.
yarn # Installs dependencies
yarn start # Launches a dev server
Once the dev server launches, log in and select a location. You will get redirected to the home page. Once there, you can either:
- Click the App Switcher icon in the top right corner and then click
Form Builder
to launch the app. - Manually navigate to the
/openmrs/spa/form-builder
URL.
To run unit tests, use:
yarn test
To run E2E tests, make sure the dev server is running by using:
yarn start
Then, in a separate terminal, run:
yarn test-e2e --headed
Please read our e2e docs for more information about E2E testing.
yarn build
yarn test