Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ucsf-ighs/openmrs-esm-ohri
ESM module for OHRI built on top of the OpenMRS Framework
https://github.com/ucsf-ighs/openmrs-esm-ohri
covid-19 javascript jest react typescript webpack
Last synced: 5 days ago
JSON representation
ESM module for OHRI built on top of the OpenMRS Framework
- Host: GitHub
- URL: https://github.com/ucsf-ighs/openmrs-esm-ohri
- Owner: UCSF-IGHS
- License: mit
- Created: 2021-03-10T13:39:58.000Z (almost 4 years ago)
- Default Branch: dev
- Last Pushed: 2025-01-14T13:26:33.000Z (10 days ago)
- Last Synced: 2025-01-17T18:00:13.555Z (7 days ago)
- Topics: covid-19, javascript, jest, react, typescript, webpack
- Language: TypeScript
- Homepage:
- Size: 12.3 MB
- Stars: 6
- Watchers: 3
- Forks: 41
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OHRI ESM
A custom microfrontend for OpenMRS HIV Reference Implementation (OHRI)
## Badges
[](https://github.com/UCSF-IGHS/openmrs-esm-ohri/actions/workflows/node.js.yml)
[](https://github.com/UCSF-IGHS/openmrs-esm-ohri/actions/workflows/node.js.yml)
## Overview
OpenMRS HIV Reference Implementation (OHRI) packages built on top of OpenMRS Frontend.
[🌍DEMO](https://openmrs-demo.globalhealthapp.net/openmrs/spa)
### Available Packages
- [esm-ohri-core-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-ohri-core-app) (OHRI Core App)
- [esm-commons-lib](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-commons-lib) (Common Libraries)
- [esm-form-render-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-form-render-app) (Form Render App)
- [esm-hiv-care-treatment-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-hiv-care-treatment-app) (HIV Care And Treatment App)
- [esm-hiv-prevention-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-hiv-prevention-app) (HIV Prevention App)
- [esm-covid-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-covid-app) (COVID-19 App)
- [esm-cervical-cancer-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-cervical-cancer-app) (Cervical Cancer App)
- [esm-ohri-pmtct-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-ohri-pmtct-app) (PMTCT App)
- [esm-ohri-tb-app](https://github.com/UCSF-IGHS/openmrs-esm-ohri/tree/master/packages/esm-tb-app) (TB App)
## Installation
### Prerequisites
* [Node](https://nodejs.org/en/download/)
* [Git](https://git-scm.com/downloads)
* [Yarn](https://yarnpkg.com)
### Setup OHRI Module
1. Clone the [openmrs-esm-ohri](https://github.com/UCSF-IGHS/openmrs-esm-ohri) repo.
```sh
git clone https://github.com/UCSF-IGHS/openmrs-esm-ohri.git
```
2. Setup repository
```sh
yarn setup
```
3. Start all packages on `localhost:8080`.
```sh
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:
```sh
yarn start:
# 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:
```sh
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](http://openmrs.org/license/) © [OpenMRS Inc.](http://www.openmrs.org/)