From dc2a7093b1f715b5a8fb7382d73886feb6876a96 Mon Sep 17 00:00:00 2001
From: rmanaem <rmanaem@protonmail.ch>
Date: Thu, 24 Oct 2024 11:27:55 -0400
Subject: [PATCH] Updated README.md with instruction for docker compose

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 852fbda..ffc9ed9 100644
--- a/README.md
+++ b/README.md
@@ -184,6 +184,23 @@ To run the tests execute the following command:
 npx cypress open
 ```
 
+## Docker compose testing environment for development
+
+Since the query tool relies on other neurobagel tools to function, their presence is often required during development. To facilitate this, a docker compose containing a complete testing environment has been created. To use it follow the steps below:
+
+1. Install `recipes` and `neurobagel_examples` submodules:
+
+```bash
+git submodule init
+git submodule update
+```
+
+2. Bring up the stack using the `test` profile:
+
+```bash
+docker compose --profile test up -d
+```
+
 ## License
 
 The query tool is released under the terms of the [MIT License](LICENSE)