👋 New to our project? Be sure to review the OpenMRS 3 Frontend Developer Documentation 🧑🏫
The openmrs-esm-patient-chart is a frontend module for the OpenMRS SPA. It contains various microfrontends that constitute widgets in a patient dashboard. These widgets include:
- Allergies
- Attachments
- Biometrics
- Conditions
- Forms
- Immunizations
- Labs
- Medications
- Notes
- Patient banner
- Patient chart
- Programs
- Vitals
In addition to these widgets, two other microfrontends exist that encapsulate cross-cutting concerns. These are:
Check out the developer documentation here.
This monorepo uses yarn.
To install the dependencies, run:
yarnTo start a dev server for a specific microfrontend, run:
yarn start --sources 'packages/esm-patient-<insert-package-name>-app'This command uses the openmrs tooling to fire up a dev server running esm-patient-chart as well as the specified microfrontend.
There are two approaches for working on multiple microfrontends simultaneously.
You could run yarn start with as many sources arguments as you require. For example, to run the biometrics and vitals microfrontends simultaneously, you'd use:
yarn start --sources 'packages/esm-patient-biometrics-app' --sources 'packages/esm-patient-vitals-app'Alternatively, you could run yarn serve from within the individual packages and then use import map overrides.
To run tests for all packages, run:
yarn turbo run testTo run tests in watch mode, run:
yarn turbo run test:watchTo run tests for a specific package, pass the package name to the --filter flag. For example, to run tests for esm-patient-conditions-app, run:
yarn turbo run test --filter=@openmrs/esm-patient-conditions-appTo run a specific test file, run:
yarn turbo run test -- visit-notes-formThe above command will only run tests in the file or files that match the provided string.
You can also run the matching tests from above in watch mode by running:
yarn turbo run test:watch -- visit-notes-formTo generate a coverage report, run:
yarn turbo run coverageBy default, turbo will cache test runs. This means that re-running tests wihout changing any of the related files will return the cached logs from the last run. To bypass the cache, run tests with the force flag, as follows:
yarn turbo run test --forceTo run end-to-end tests, run:
yarn test-e2eRead the e2e testing guide to learn more about End-to-End tests in this project.
The Playwright version in the Bamboo e2e Dockerfile and the package.json file must match. If you update the Playwright version in one place, you must update it in the other.
If you notice that your local version of the application is not working or that there's a mismatch between what you see locally versus what's in dev3, you likely have outdated versions of core libraries. To update core libraries, run the following commands:
# Upgrade core libraries
yarn up openmrs@next @openmrs/esm-framework@next
# Reset version specifiers to `next`. Don't commit actual version numbers.
git checkout package.json
# Run `yarn` to recreate the lockfile
yarnThe patient chart consists of the following parts:
- Navigation menu
- Patient header
- Chart review / Dashboards
- Workspace
- Side menu
The navigation menu lives on the left side of the screen and provides links to dashboards in the patient chart.
The patient header contains the patient banner. Uninvasive notifications also appear in this area following actions such as form submissions.
The chart review area is the main part of the screen. It displays whatever dashboard is active.
A dashboard is a collection of widgets.
The workspace is where data entry takes place. On mobile devices it covers the screen; on desktop it appears in a sidebar.
The side menu provides access to features that do not have their own pages, such as the notifications menu.
For documentation about our design patterns, please visit our design system documentation website.
Please see the Implementer Documentation for information about configuring modules.
See Creating a Distribution for information about adding microfrontends to a distribution.