17427: Add some notes on developing using Docker
authorPeter Amstutz <peter.amstutz@curii.com>
Mon, 12 Apr 2021 18:05:02 +0000 (14:05 -0400)
committerDaniel KutyƂa <daniel.kutyla@contractors.roche.com>
Fri, 23 Apr 2021 11:02:56 +0000 (13:02 +0200)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

README.md

index f6a7e48587522f8dcf90592582dd47ca571b14e6..8bb50dbeb91c90aa06c801e8d036fa74a31578ea 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,6 +17,17 @@ Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/red
 yarn start
 ```
 
 yarn start
 ```
 
+## Start project for development inside Docker container
+
+```
+make workbench2-build-image
+# (create public/config.json, see "Run time configuration" below)
+docker run -ti -v$PWD:$PWD -p 3000:3000 -w$PWD workbench2-build /bin/bash
+# (inside docker container)
+yarn install
+yarn start
+```
+
 ## Run unit tests
 ```
 make unit-tests
 ## Run unit tests
 ```
 make unit-tests
@@ -37,12 +48,12 @@ make integration-tests-in-docker
 ## Run tests interactively in container
 
 ```
 ## Run tests interactively in container
 
 ```
-xhost +local:root
-ARVADOS_DIR=/path/to/arvados
-docker run -ti -v$PWD:$PWD -v$ARVADOS_DIR:/usr/src/arvados -w$PWD --env="DISPLAY" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" workbench2-build /bin/bash
+xhost +local:root
+ARVADOS_DIR=/path/to/arvados
+docker run -ti -v$PWD:$PWD -v$ARVADOS_DIR:/usr/src/arvados -w$PWD --env="DISPLAY" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" workbench2-build /bin/bash
 (inside container)
 (inside container)
-yarn run cypress install
-tools/run-integration-tests.sh -i -a /usr/src/arvados
+yarn run cypress install
+tools/run-integration-tests.sh -i -a /usr/src/arvados
 ```
 
 ## Production build
 ```
 
 ## Production build