Skip to content

ESM module for OHRI built on top of the OpenMRS Framework

License

Notifications You must be signed in to change notification settings

UCSF-IGHS/openmrs-esm-ohri

Repository files navigation

OHRI ESM

A custom microfrontend for OpenMRS HIV Reference Implementation (OHRI)

Badges

Node.js CI Node.js CI

Overview

OpenMRS HIV Reference Implementation (OHRI) packages built on top of OpenMRS Frontend.

🌍DEMO

Available Packages

Installation

Prerequisites

Setup OHRI Module

  1. Clone the openmrs-esm-ohri repo.
git clone https://github.com/UCSF-IGHS/openmrs-esm-ohri.git
  1. Setup repository
yarn setup
  1. Start all packages on localhost:8080.
yarn start

This command start each package inside the packages directory with the development mode connected to the https://openmrs-demo.globalhealthapp.net backend. This is the actual script:

If you would like to run individual packages, you can use the following command:

yarn start:<package-name>

# for example

# To start ohri core
yarn start:core

# To start covid esm
yarn start:covid

# To start hiv care and treatment esm
yarn start:hct

# To start hiv prevention esm
yarn start:hp

# To start cervical-cancer esm
yarn start:cervical-cancer

# To start form-render esm
yarn start:form-render

# To start pmtct esm
yarn start:pmtct

Tests

To verify that all of the tests run:

yarn test

Note: Run npm i before running tests for the first time.

Deployment

TBD

Configuration

This module is designed to be driven by configuration files. These files define the look and functionality required to drive the OHRI module.

Note: Currently, the module cannot be configured as it is in the early stages of development.

Resources

Optional Steps: To run against a deployment server (to reflect local changes that will be on server upon Deployment): On terminal run -> npx openmrs develop --backend https://{server-address}

(tbd)

Acknowledgements

(tbd)

License

MPL 2.0 w/ HD © OpenMRS Inc.