Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial commit #1

Merged
merged 1 commit into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 2 additions & 2 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading