Skip to content

Commit

Permalink
(docs) Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
denniskigen committed Mar 5, 2024
1 parent b4b2c7a commit bd4c96b
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:wave: *New to our project? Be sure to review the [OpenMRS 3 Frontend Developer Documentation](https://openmrs.github.io/openmrs-esm-core/#/). You may find the [Map of the Project](https://openmrs.github.io/openmrs-esm-core/#/main/map) especially helpful.* :teacher:
:wave: *New to our project? Be sure to review the [OpenMRS 3 Frontend Developer Documentation](https://om.rs/o3docs/#/)* :teacher:

![Node.js CI](https://github.com/openmrs/openmrs-esm-admin-tools/workflows/Node.js%20CI/badge.svg)
[![OpenMRS CI](https://github.com/openmrs/openmrs-esm-admin-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/openmrs/openmrs-esm-admin-tools/actions/workflows/ci.yml)

# OpenMRS ESM Admin Tools

Expand All @@ -9,13 +9,13 @@
openmrs-esm-admin-tools provides microfrontends for various administrative functions and administrative modules in the OpenMRS ecosystem. It provides tools to allow admin users to effectively manage their 3.x installation without needing to drop to the v1 console.

## How do I configure this module?

Please see the [Implementer Documentation](https://wiki.openmrs.org/display/projects/Frontend+3.0+Documentation+for+Implementers#Frontend3.0DocumentationforImplementers-Configuringtheapplication)
for information about configuring modules.

Please see the [O3 Docs config guide](https://o3-docs.openmrs.org/docs/configure-o3/overview#configuring-individual-frontend-modules) for information about configuring modules.

## Setup

See the guidance in the [Developer Documentation](https://o3-dev.docs.openmrs.org/#/getting_started/prerequisites).
See the guidance in the [Developer Documentation](https://o3-docs.openmrs.org/docs/prerequisite-knowledge).

This repository uses Yarn.

To start the dev server for a specific package, run
Expand Down Expand Up @@ -96,7 +96,6 @@ To set up environment variables for the project, follow these steps:

Note: These variables are currently only used for end-to-end tests.


To run E2E tests, make sure the dev server is running by using:

```sh
Expand All @@ -114,5 +113,4 @@ Please read [our e2e docs](e2e/README.md) for more information about E2E testing
## Deployment

See the
[Frontend Implementer Documentation](https://wiki.openmrs.org/display/projects/Frontend+3.0+Documentation+for+Implementers)
for information about adding microfrontends to a distribution.
[Frontend Implementer Documentation](https://wiki.openmrs.org/display/projects/Frontend+3.0+Documentation+for+Implementers) for information about adding microfrontends to a distribution.

0 comments on commit bd4c96b

Please sign in to comment.