Skip to content

Commit

Permalink
Updated README.md with instruction for docker compose
Browse files Browse the repository at this point in the history
  • Loading branch information
rmanaem committed Oct 24, 2024
1 parent 7edc0b6 commit dc2a709
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit dc2a709

Please sign in to comment.