From d770db61de9bcc4c2ca83e429a345a8e5e7f895b Mon Sep 17 00:00:00 2001
From: AJAL ODORA JONATHAN <43242517+ODORA0@users.noreply.github.com>
Date: Thu, 10 Oct 2024 09:40:04 +0300
Subject: [PATCH] Update Readme for billing esm (#64)

---
 README.md | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 110 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4c5cf7a..5900e98 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,115 @@
 # OpenMRS 3.x Billing ESM
 
-Billing microfontend for O3.
+The OpenMRS Billing Module is designed to streamline the financial operations within healthcare settings by facilitating the management of patient billing, payments, and service pricing. This module integrates seamlessly with the OpenMRS platform, allowing healthcare providers to generate bills, track payments, and manage various billable services. It is an essential tool for ensuring transparency and accuracy in financial transactions within healthcare facilities, contributing to efficient service delivery.
+
+For more information, please see the
+[OpenMRS Frontend Developer Documentation](https://o3-docs.openmrs.org/#/).
+
+## Local development
+
+Check out the developer documentation [here](http://o3-dev.docs.openmrs.org).
+
+This monorepo uses [yarn](https://yarnpkg.com).
+
+To install the dependencies, run:
+
+```bash
+yarn
+```
+
+To start a dev server, run:
+
+```bash
+yarn start
+```
+
+Once the dev server launches, log in and select a location. You will get redirected to the home page. Once there:
+
+* Go to the Implementers tools, under the feature flags, toggle on the Billing Module feature flag to access billing functionalities.
+* For more information on how to navigate and use the billing module, please refer to this [documentation](https://www.notion.so/ucsf-ighs/Billing-User-Manual-7f0427617e714b7db14432312cbb7cad) 
+
+## Running tests
+
+To run tests for all packages, run:
+
+```bash
+yarn turbo run test
+```
+
+To run tests in `watch` mode, run:
+
+```bash
+yarn turbo run test:watch
+```
+To run a specific test file, run:
+
+```bash
+yarn turbo run test -- visit-notes-form
+```
+
+The above command will only run tests in the file or files that match the provided string.
+
+You can also run the matching tests from above in watch mode by running:
+
+```bash
+yarn turbo run test:watch -- visit-notes-form
+```
+
+To generate a `coverage` report, run:
+
+```bash
+yarn turbo run coverage
+```
+
+By default, `turbo` will cache test runs. This means that re-running tests wihout 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
+```
+
+To run end-to-end tests, run:
+
+```bash
+yarn test-e2e
+```
+
+Read the [e2e testing guide](https://o3-docs.openmrs.org/docs/frontend-modules/end-to-end-testing) to learn more about End-to-End tests in this project.
+
+### Updating Playwright
+
+The Playwright version in the [Bamboo e2e Dockerfile](e2e/support/bamboo/playwright.Dockerfile#L2) and the `package.json` file must match. If you update the Playwright version in one place, you must update it in the other.
+
+## 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.
+```bash
+git checkout package.json
+```
+
+### Run `yarn` to recreate the lockfile
+```bash
+yarn
+```
+
+## Design Patterns
+
+For documentation about our design patterns, please visit our [design system](https://zeroheight.com/23a080e38/p/880723--introduction) documentation website.
+
+## Configuration
+
+Please see the [Implementer Documentation](https://wiki.openmrs.org/pages/viewpage.action?pageId=224527013) for information about configuring modules.
+
+## Deployment
+
+See [Creating a Distribution](http://o3-dev.docs.openmrs.org/#/main/distribution?id=creating-a-distribution) for information about adding microfrontends to a distribution.
 
 ## Contributing
 
-For more information on how to get started, please refer to [OpenMRS Frontend Developer Documentation](https://o3-docs.openmrs.org/docs/introduction).
+For more information on how to get started, please refer to [OpenMRS Frontend Developer Documentation](https://o3-docs.openmrs.org/docs/introduction).
\ No newline at end of file