diff --git a/README.md b/README.md index b05055c..6a871a5 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,32 @@ -![Node.js CI](https://github.com/METS-Programme/esm-ugandaemr-template-app/workflows/Node.js%20CI/badge.svg) +# OpenMRS 3.x APPS ESM -# UgandaEMR Template app +A frontend module for managing apps built on OpenMRS 3.x -![Landing page screenshot](./src/assets/images/screen.png) -A starter template ESM for UgandaEMR inspired by https://github.com/openmrs/openmrs-esm-template-app. +For more information, please refer to the +[OpenMRS 3.x Frontend Documentation](https://openmrs.github.io/openmrs-esm-core/#/). -You can use this repo as a template to spawn new frontend modules for UgandaEMR. +# Getting Started -The current setup works best for setting up polyrepos. To adapt the template for a monorepo setup, you'll need to make the following changes: +```sh +# Clone the repository +git clone https://github.com/METS-Programme/esm-menu-app.git -- Add a `packages` directory inside of `src`. +# to install dependencies +yarn +# to run the dev server +yarn start + +# OR to start on a specified port eg 5000 +yarn start --port 5000 +``` + +Once it is running, a browser window +should open with the OpenMRS 3 application. Log in and then navigate to +`/openmrs/spa/home`. + +# Running tests +``` +yarn run test +``` diff --git a/package.json b/package.json index e8729bc..2f05ca7 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,13 @@ { - "name": "@ugandaemr/esm-template-app", + "name": "@ugandaemr/esm-menu-app", "version": "1.0.0", "license": "MPL-2.0", - "description": "A template for creating frontend modules for UgandaEMR", - "browser": "dist/esm-ugandaemr-template-app.js", + "description": "A frontend module for managing apps built on OpenMRS 3.x", + "browser": "dist/esm-menu-app.js", "main": "src/index.ts", "source": true, "scripts": { - "start": "openmrs develop", + "start": "openmrs develop --backend http://167.71.32.250:8080", "serve": "webpack serve --mode=development", "build": "webpack --mode production", "analyze": "webpack --mode=production --env analyze=true", @@ -34,14 +34,14 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/mets-programme/esm-ugandaemr-template-app.git" + "url": "git+https://github.com/METS-Programme/esm-menu-app.git" }, - "homepage": "https://github.com/mets-programme/esm-ugandaemr-template-app#readme", + "homepage": "https://github.com/mets-programme/esm-menu-app#readme", "publishConfig": { "access": "public" }, "bugs": { - "url": "https://github.com/mets-programme/esm-ugandaemr-template-app/issues" + "url": "https://github.com/mets-programme/esm-menu-app/issues" }, "dependencies": { "@carbon/react": "^1.33.1", diff --git a/src/index.ts b/src/index.ts index a96b4da..29d3b23 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,7 +1,7 @@ import { getAsyncLifecycle, defineConfigSchema } from "@openmrs/esm-framework"; import { configSchema } from "./config-schema"; -const moduleName = "@ugandaemr/esm-template-app"; +const moduleName = "@ugandaemr/esm-menu-app"; const options = { featureName: "root", diff --git a/yarn.lock b/yarn.lock index 631c8e8..4c183ce 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5193,9 +5193,9 @@ __metadata: languageName: node linkType: hard -"@ugandaemr/esm-template-app@workspace:.": +"@ugandaemr/esm-menu-app@workspace:.": version: 0.0.0-use.local - resolution: "@ugandaemr/esm-template-app@workspace:." + resolution: "@ugandaemr/esm-menu-app@workspace:." dependencies: "@carbon/react": ^1.33.1 "@openmrs/esm-framework": next