Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openmrs/openmrs-esm-home
The homepage microfrontend for the OpenMRS SPA
https://github.com/openmrs/openmrs-esm-home
microfrontend openmrs react spa typescript
Last synced: 5 days ago
JSON representation
The homepage microfrontend for the OpenMRS SPA
- Host: GitHub
- URL: https://github.com/openmrs/openmrs-esm-home
- Owner: openmrs
- License: other
- Created: 2019-08-22T17:11:42.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-24T07:58:48.000Z (12 days ago)
- Last Synced: 2025-01-24T17:12:58.156Z (12 days ago)
- Topics: microfrontend, openmrs, react, spa, typescript
- Language: TypeScript
- Homepage:
- Size: 7.74 MB
- Stars: 16
- Watchers: 50
- Forks: 77
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
:wave: *New to our project? Be sure to review the [OpenMRS 3 Frontend Developer Documentation](https://o3-docs.openmrs.org/docs/introduction)*.
# OpenMRS ESM Home
An [OpenMRS Microfrontend](https://openmrs.atlassian.net/wiki/spaces/projects/pages/26936899/OpenMRS+3.0+A+Frontend+Framework+that+enables+collaboration+and+better+User+Experience) for the O3 Home page.
## What is this?
openmrs-esm-home is an in-browser [javascript module](https://github.com/openmrs/openmrs-rfc-frontend/blob/master/text/0002-modules.md)
that is a [single-spa application](https://single-spa.js.org/docs/building-applications.html). It is responsible for rendering the UI for the landing page after the user logs in.
## Contributing / Development
Check out the developer documentation [here](https://o3-docs.openmrs.org/docs/frontend-modules/development).
This monorepo uses [yarn](https://yarnpkg.com/).
To install the dependencies, run:
```bash
yarn
```
To start a dev server for the home app, run:
```bash
yarn start --sources 'packages/esm-home-app'
```
## Running tests
To run all tests, run:
```bash
yarn turbo run test --filter=@openmrs/esm-home-app
```
To run a specific test file, run:
```bash
yarn turbo run test --
```
The above command will only run tests in the file or files that match the provided string.
To generate a `coverage` report, run:
```bash
yarn turbo run coverage
```
By default, `turbo` will cache test runs. This means that re-running tests without changing any of the related files will return the cached logs from the last run. To bypass the cache, run tests with the `force` flag, as follows:
```bash
yarn turbo run test --force
```
## Troubleshooting
If you notice that your local version of the application is not working or that there's a mismatch between what you see locally versus what's in [dev3](https://dev3.openmrs.org/openmrs/spa), you likely have outdated versions of core libraries. To update core libraries, run the following commands:
```bash
# Upgrade core libraries
yarn up openmrs@next @openmrs/esm-framework@next
# Reset version specifiers to `next`. Don't commit actual version numbers.
git checkout package.json
# Run `yarn` to recreate the lockfile
yarn
```
## Design Patterns
For documentation about our design patterns, please visit our [design system](https://om.rs/o3ui) documentation website.
## Configuration
Please see the [Implementer Documentation](https://wiki.openmrs.org/pages/viewpage.action?pageId=224527013) for information about configuring modules.