|
1 | | -:wave: *New to our project? Be sure to review the [OpenMRS 3 Frontend Developer Documentation](https://o3-docs.openmrs.org/docs/introduction)*. |
| 1 | +# DEPRECATED |
2 | 2 |
|
3 | | - |
4 | | - |
5 | | -# OpenMRS ESM Home |
6 | | - |
7 | | -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. |
8 | | - |
9 | | -## What is this? |
10 | | - |
11 | | -openmrs-esm-home is an in-browser [javascript module](https://github.com/openmrs/openmrs-rfc-frontend/blob/master/text/0002-modules.md) |
12 | | -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. |
13 | | - |
14 | | -## Contributing / Development |
15 | | - |
16 | | -Check out the developer documentation [here](https://o3-docs.openmrs.org/docs/frontend-modules/development). |
17 | | - |
18 | | -This monorepo uses [yarn](https://yarnpkg.com/). |
19 | | - |
20 | | -To install the dependencies, run: |
21 | | - |
22 | | -```bash |
23 | | -yarn |
24 | | -``` |
25 | | - |
26 | | -To start a dev server for the home app, run: |
27 | | - |
28 | | -```bash |
29 | | -yarn start --sources 'packages/esm-home-app' |
30 | | -``` |
31 | | - |
32 | | -## Running tests |
33 | | - |
34 | | -To run all tests, run: |
35 | | - |
36 | | -```bash |
37 | | -yarn turbo run test --filter=@openmrs/esm-home-app |
38 | | -``` |
39 | | - |
40 | | -To run a specific test file, run: |
41 | | - |
42 | | -```bash |
43 | | -yarn turbo run test -- <test-file-name> |
44 | | -``` |
45 | | - |
46 | | -The above command will only run tests in the file or files that match the provided string. |
47 | | - |
48 | | -To generate a `coverage` report, run: |
49 | | - |
50 | | -```bash |
51 | | -yarn turbo run coverage |
52 | | -``` |
53 | | - |
54 | | -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: |
55 | | - |
56 | | -```bash |
57 | | -yarn turbo run test --force |
58 | | -``` |
59 | | - |
60 | | -## Troubleshooting |
61 | | - |
62 | | -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: |
63 | | - |
64 | | -```bash |
65 | | -# Upgrade core libraries |
66 | | -yarn up openmrs@next @openmrs/esm-framework@next |
67 | | - |
68 | | -# Reset version specifiers to `next`. Don't commit actual version numbers. |
69 | | -git checkout package.json |
70 | | - |
71 | | -# Run `yarn` to recreate the lockfile |
72 | | -yarn |
73 | | -``` |
74 | | - |
75 | | -## Design Patterns |
76 | | - |
77 | | -For documentation about our design patterns, please visit our [design system](https://om.rs/o3ui) documentation website. |
78 | | - |
79 | | -## Configuration |
80 | | - |
81 | | -Please see the [Implementer Documentation](https://wiki.openmrs.org/pages/viewpage.action?pageId=224527013) for information about configuring modules. |
| 3 | +This module has been moved to the [Patient Management](https://github.com/openmrs/openmrs-esm-patient-management/tree/main/packages/esm-home-app) repository. |
0 commit comments