esm-ohri-hiv-app v0.0.1

OHRI ESM

A custom microfrontend for OpenMRS HIV Reference Implementation (OHRI)

Badges

Overview

(tbd)

Built With

• React (TypeScript) - Front-end JS library
• Formik - Form builder JS library
• Day.js - Date library
• Jest - JS testing framework
• React Testing Library - JS testing library for React components
• npm - Node package manager
• webpack - JS module bundler
• ESLint - JS linter
• Prettier - Code formatter
• Babel - JS compiler
• Travis CI - CI service

Installation

Prerequisites

• Node
• Git
• openmrs-esm-ohri

Setup OHRI Module

1. Clone the openmrs-esm-ohri repo.

git clone https://github.com/UCSF-IGHS/openmrs-esm-ohri.git

2. Install dependencies in the root directory of the repo.

• make sure you are using a relatively recent version of node, LTE is 14.x.x, you can type node -version to find your current version. I would recommend using n to manage your node version: see https://www.npmjs.com/package/n

npm i

3. Run the module from localhost:8080.

npm run serve

Setup Dev Tools

1. Click Add new module in the dev tools window.
2. Type in the Module Name: @openmrs/esm-ohri-app.
3. Type in the Override URL: 8080.
4. Go to the browser's development tools (e.g. via Inspect).
5. Go to the Application tab.
6. Go to Local Storage.
7. Find the key: import-map-override:@openmrs/esm-ohri-app
8. Update the corresponding value to: //localhost:8080/openmrs-esm-ohri.js.
9. Click on the padlock/warning message next to the URL in the browser.
10. Select the Allow option from the Insecure content dropdown in the browser settings page.
11. Refresh the page.

Optional Steps: To enable Devtools (a gray or red rectangular button near the bottom right of the screen): Open cosole of Developer Tools -> In console enter: localStorage.setItem('openmrs:devtools', true)

Tests

To verify that all of the tests run:

npm test

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

Deployment

Currently, available releases for this module:

• []

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.