Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mseaton committed Mar 15, 2024
1 parent c291c0e commit 198eb4b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 18 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,18 @@ To start a dev server for a specific module, run:
yarn start --sources 'packages/esm-<insert-package-name>-app'
```

To do this with specific configuration, run:
To do this against your local SDK with a typical set of PIH EMR configuration files:

```bash
yarn start --backend "http://localhost:8080/" --config-url "site/base-config.json" --config-url "site/config.json" --sources 'packages/esm-<insert-package-name>-app' --port 8081
```

To develop against a remote server backend or with a custom OpenMRS webapp name:

```bash```

yarn start --backend "https://humci.pih-emr.org/" --api-url /mirebalais/ --spa-path /mirebalais/spa/ --port 8081 --sources "packages/esm-referrals-queue-app/"

You could provide `yarn start` with as many `sources` arguments as you require. For example:

```bash
Expand Down
18 changes: 1 addition & 17 deletions packages/esm-referrals-queue-app/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# @pih/esm-referrals-queue
# @pih/esm-referrals-queue-app

A page for viewing the J9 Home Visits from CommCare

[![Build Status](https://travis-ci.com/pih/pih-esm-referrals-queue.svg?branch=master)](https://travis-ci.com/pih/pih-esm-referrals-queue)

## Design Notes

*See from [PIH Confluence](https://pihemr.atlassian.net/wiki/spaces/DSS/pages/538116104/PIH+EMR+Referrals+Queue)*
Expand All @@ -13,20 +11,6 @@ There should be one row per referral in this list (not one per encounter). Some
Note that the basic referrals workflow would be for J9 clinicians/managers to view the list of referrals here, then take action upon them one by one by clicking on the “pending” referrals. This will bring them into editing the Home Visit form from which the referral came. From there they specify any action taken on the referral and navigate back to this list.
Check out the [design doc](https://pihemr.atlassian.net/wiki/spaces/DSS/pages/538116104/PIH+EMR+Referrals+Queue).

## Development
```sh
# to install dependencies
yarn

# will run against a local OpenMRS server at localhost:8080, serving the frontend from 8081
yarn start --backend "http://localhost:8080/" --port 8081

# run against HUM-CI, serving the frontend from 8080
yarn start --backend "http://humci.pih-emr.org/" --api-url /mirebalais/
```



## Configuration
<!-- GENERATED BY OPENMRS CONFIG CLI -->
See the [openmrs-esm-module-config docs](https://wiki.openmrs.org/display/projects/openmrs-esm-module-config)
Expand Down

0 comments on commit 198eb4b

Please sign in to comment.