Information for developers about the OpenMRS Frontend system can be found at the following link:
Below is the documentation for this repository.
This contains tooling and the app shell.
The following common libraries have been developed. They may also be used independently of the app shell.
All libraries are aggregated in the
A set of frontend modules provide the core technical functionality of the application.
To set up the repository for development, run the following commands:
yarn install yarn setup
To build all packages in the repository, run the following command:
lerna run build
Verification of the existing packages can also be done in one step using
cd packages/apps/esm-[xyz]-app yarn start
cd packages/tooling/openmrs yarn build ./dist/cli.js
To increment the version, run the following command:
You will need to pick the next version number. We use minor changes (e.g.
to indicate big new features and breaking changes, and patch changes (e.g.
Note that this command will not create a new tag, nor publish the packages.
After running it, make a PR or merge to
master with the resulting changeset.
Once the version bump is merged, go to GitHub and
draft a new release.
The tag should be prefixed with
v3.2.1), while the release title
should just be the version number (e.g.,
3.2.1). The creation of the GitHub release
will cause GitHub Actions to publish the packages, completing the release process.
yarn publish, or
lerna publish. Use the above process.
The new architecture offers a couple of interesting possibilities. We go into them one by one.
We can now proxy any backend. For instance, using the backend of the demo instance we just run:
npx openmrs debug --backend https://demo.openmrs.org/
There are a couple of interesting public instances:
https://qa-refapp.openmrs.org/ https://demo.openmrs.org/ https://openmrs-spa.org/