:wave: New to our project? Be sure to review the OpenMRS 3 Frontend Developer Documentation. You may find the Map of the Project especially helpful. :teacher:

OpenMRS Patient Management

This repository contains frontend modules for O3. These modules relate to registering and editing patients, searching for existing patients, creating and managing patient lists, managing patient queues in an outpatient setting and creating, editing and managing patient appointments. The modules within this repository include:

• Active visits app
• Appointments app
• Bed management
• Patient list management
• Patient registration
• Patient search
• Service queues
• Ward

Setup

Check out the developer documentation here.

This monorepo uses yarn.

To install the dependencies, run:

yarn install

To set up environment variables for the project, follow these steps:

1. Create a copy of the .env.example file by running the following command:

   cp example.env .env

2. Open the newly created .env file in the root of the project.

3. Add the environment variables you need.

Note: These variables are currently only used for end-to-end tests.

To start a dev server for a specific module, run:

yarn start --sources 'packages/esm-<insert-package-name>-app'

This command uses the openmrs tooling to fire up a dev server running esm-patient-management as well as the specified module.

You could provide yarn start with as many sources arguments as you require. For example, to run the patient registration and patient search modules only, use:

yarn start --sources 'packages/esm-patient-search-app' --sources 'packages/esm-patient-registration-app'

To run an app locally with the same configuration that is set in the reference application, use:

yarn start --config-url /openmrs/spa/config-core_demo.json --sources 'packages/esm-<insert-package-name>-app'

Troubleshooting

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 the reference application, you likely have outdated versions of core libraries. To update core libraries, run the following commands:

# Upgrade core libraries
yarn up openmrs @openmrs/esm-framework

# Reset version specifiers to `next`. Don't commit actual version numbers.
git checkout package.json

# Run `yarn` to recreate the lockfile
yarn

Contributing

Please read our contributing guide.

Running tests

To run tests for all packages, run:

yarn turbo run test

To run tests in watch mode, run:

yarn turbo run test:watch

To 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 test --filter=@openmrs/esm-patient-conditions-app

To run a specific test file, run:

yarn turbo run test -- basic-search

The 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 --basic-search

To generate a coverage report, run:

yarn turbo run coverage

By 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 --force

Unit tests

To run unit tests, use:

yarn test

E2E tests

To run E2E tests, make sure the dev server is running by using:

yarn start --sources 'packages/esm-*-app/'

Then, in a separate terminal, run:

yarn test-e2e --headed

Please read our E2E testing guide for more information about E2E testing.

Updating Playwright

To upgrade your Playwright version, update both the package.json file and the e2e/support/bamboo/playwright.Dockerfile.

Design patterns

For documentation about our design patterns, please visit our design system documentation website.

Deployment

The main branch of this repo is deployed in a demo environment.

Configuration

This module is designed to be driven by configuration files.

Version and release

To increment the version, run the following command:

yarn release

You will need to pick the next version number. We use minor changes (e.g. 3.2.0 → 3.3.0) to indicate big new features and breaking changes, and patch changes (e.g. 3.2.0 → 3.2.1) otherwise.

Note that this command will not create a new tag, nor publish the packages. After running it, make a PR or merge to main with the resulting changeset.

Once the version bump is merged, go to GitHub and draft a new release. The tag should be prefixed with v (e.g., v3.2.1), while the release title should 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.

Don't run npm publish or yarn publish. Use the above process.

Bumping the Common Lib version

Make sure to bump the Common Lib version used here each time you cut a release of Patient Chart. Because Common Lib is marked as a peer dependency and a Webpack module federation shared dependency in the Appointments app, the copy of the Common Lib that the framework loads is the first one that gets loaded at runtime when frontend modules are registered. If this happens to be a different version than what the Patient Chart expects, you might get some unexpected behavior in the Patient Chart. You can bump the Common Lib version by running the following command:

yarn up @openmrs/esm-patient-common-lib
git checkout package.json
yarn