-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
streamlined the repository to work with openmrs tooling
- Loading branch information
Donald Kibet
committed
May 27, 2021
1 parent
eb44721
commit e91cbe2
Showing
87 changed files
with
27,565 additions
and
25,056 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
{ | ||
"extends": [ | ||
"ts-react-important-stuff", | ||
"plugin:prettier/recommended" | ||
] | ||
} | ||
"parser": "@typescript-eslint/parser", | ||
"plugins": [ | ||
"@typescript-eslint" | ||
], | ||
"extends": ["ts-react-important-stuff", "plugin:prettier/recommended"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
dist/ | ||
node_modules/ | ||
**/*.css | ||
**/*.scss | ||
**/*.md | ||
**/*.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,65 @@ | ||
# `@ampath/esm-client-dashboard` | ||
# Ampath Clinic dashboard | ||
|
||
A monorepo for all the different clinic dashboard widgets. | ||
This is a [lerna](https://lerna.js.org) project containing ampath clinic dashboard micro-frontend. | ||
This package includes the following | ||
|
||
## Available Packages | ||
- [@ampath/esm-hiv-clinic-dashboard-app](packages/esm-hiv-clinic-dashboard-app) | ||
|
||
- HIV-related dashboard items | ||
* Lists (...) | ||
* Visualizations (...) | ||
* Reports (...) | ||
- Oncology related items | ||
* Lists (...) | ||
- Diabetes related items | ||
* Lists (...) | ||
## Repository Development | ||
|
||
## Commands | ||
### Prerequisites | ||
|
||
If you want to debug a certain microfrontend (e.g., `@ampath/esm-clinic-dashboard-oncology-lists`): | ||
- [Node](https://nodejs.org/downloads) version ^10 | ||
- yarn ```sh npm install yarn -g ``` | ||
- lerna ```sh npm install lerna -g ``` | ||
|
||
### Getting started | ||
|
||
|
||
To install and setup the repository once cloned, just use the following command | ||
|
||
```sh | ||
name=oncology-lists yarn debug | ||
npx lerna bootstrap | ||
``` | ||
|
||
For changing the port please use `port` (e.g., `8085`): | ||
To develop a specific package e.g. [@ampath/esm-hiv-clinic-dashboard-app](packages/esm-hiv-clinic-dashboard-app) | ||
|
||
run this command | ||
|
||
```sh | ||
port=8085 yarn debug | ||
npx openmrs develop --sources 'packages/esm-hiv-clinic-dashboard-app' | ||
``` | ||
|
||
You can always use regex to run multiple packages | ||
|
||
```sh | ||
npx openmrs develop --sources 'packages/esm-{package1,package2}-app` | ||
``` | ||
### Building | ||
For building the code just run | ||
```sh | ||
npx lerna run build | ||
``` | ||
Of course, you can combine these: | ||
### Tests | ||
To verify that all the test run from the root directory | ||
```sh | ||
port=8085 name=oncology-lists yarn debug | ||
yarn test or npm test | ||
``` | ||
By default, port `8080` and `@ampath/esm-clinic-dashboard-hiv-lists` is taken. | ||
## Deployment | ||
The `master` branch of this repo is deployed in [ng2-amrs](https://github.com/AMPATH/ng2-amrs) | ||
## Configuration | ||
This module is designed to be driven by configuration files. | ||
## Resources | ||
- [JIRA Epic](https://jira.ampath.or.ke/) |
Oops, something went wrong.