From cb05cc8c598a73c6197e2628f4fc369da1baf065 Mon Sep 17 00:00:00 2001
From: kdaud
Date: Wed, 15 Mar 2023 07:58:05 +0300
Subject: [PATCH] Add a prerequisite section in the README.md
---
README.md | 35 ++++++++++-------------------------
1 file changed, 10 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index 69773db..8d4e6a9 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,14 @@ Docker Compose project to run Bahmni.
+### Run Ozone FOSS locally
+
+#### Prerequisites
+Install Git, Maven and Docker Compose
+
+#### For Linux OS
+Create the docker group and add your user to it. Checkout the guide [here](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user).
+
## Quick Start
### Create your working directory:
@@ -19,7 +27,7 @@ cd ~/
Then create the working directory and save the path:
```
export BAHMNI_DIR=$PWD/bahmni && \
-mkdir $BAHMNI_DIR
+mkdir $BAHMNI_DIR && cd $BAHMNI_DIR
```
### Download the Docker Compose project itself:
@@ -64,35 +72,12 @@ export EIP_CONFIG_PATH=$DISTRO_PATH/eip_config
The complete list of available variables can be found in [.env](.env).
-### Move to the location of bahmni-docker-compose project
-
-```bash
-cd $BAHMNI_DIR/bahmni-docker-compose-$VERSION
-```
-
### Start Bahmni:
-
-
- macOS | Linux |
-
-
-
-
```bash
docker compose -p $DISTRO_GROUP up
```
- |
-
-
-```bash
-sudo -E docker compose -p $DISTRO_GROUP up
-```
- |
-
-
-
@@ -262,7 +247,7 @@ watch rsync -av ~/repos/openmrs-module-bahmniapps/ui/ /tmp/bahmni-distro-haiti/b
### Debug the Java apps
-The Java apps (OpenMRS, Bahmni Reports, Odoo Connect...) can be remote debugged very simply by setting a the `DEBUG: "true"` environment variable to the service.
+The Java apps (OpenMRS, Bahmni Reports, Odoo Connect...) can be remote debugged very simply by setting a `DEBUG: "true"` environment variable to the service.
Don't forget to open the port `8000` on the service as well:
Eg: