From 4a7c5ea3f0d62147e5a3fd5bf1cdfb53b80153d5 Mon Sep 17 00:00:00 2001 From: Ian <52504170+ibacher@users.noreply.github.com> Date: Thu, 8 Feb 2024 08:46:57 -0500 Subject: [PATCH] Fix README.md --- README.md | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 36168c1..2b70539 100644 --- a/README.md +++ b/README.md @@ -8,26 +8,15 @@ 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. -Please note that at this time, these microfrontends currently aren't deployed or running anywhere. +## 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. ## Setup See the guidance in the [Developer Documentation](https://o3-dev.docs.openmrs.org/#/getting_started/prerequisites). -This repository uses Yarn and Lerna. - -To set up environment variables for the project, follow these steps: - -1. Create a copy of the .env.example file by running the following command: - - ```bash - cp example.env .env - ``` - -2. Open the newly created .env file in the root of the project. - -3. Add the environment variables you need. - -Note: These variables are currently only used for end-to-end tests. +This repository uses Yarn. To start the dev server for a specific package, run @@ -45,11 +34,6 @@ yarn start-all Note that this is very much not recommended. -## 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. - ## Running tests To run tests for all packages, run: @@ -98,6 +82,21 @@ yarn turbo test --force ### E2E tests +To set up environment variables for the project, follow these steps: + +1. Create a copy of the .env.example file by running the following command: + + ```bash + cp example.env .env + ``` + +2. Open the newly created .env file in the root of the project. + +3. Add the environment variables you need. + +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