README.md

Drug Order ESM

The Drug Order MF module for OpenMRS Version 3.0 Frontend.

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-drugorder

Setup Patient Registration Module

1. Clone the openmrs-esm-drugorder repo.

git clone https://github.com/openmrs/openmrs-esm-drugorder.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-drugorder-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-drugorder-app
8. Update the corresponding value to: //localhost:8080/openmrs-esm-drugorder.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.

Tests

To verify that all of the tests run:

npm test

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

Deployment

Currently, there are no releases for this module and it can only be locally deployed by following the installation instructions.

Configuration

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

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

Resources

• JIRA Epic

Acknowledgements

• Manuel Römer - maintenance, design, analysis, onboarding, and development.
• Florian Rappl - module scaffolding, onboarding, guidance, and review.

License

The project is licensed under the MIT License - see the LICENSE.md file for details.