Merge branch '21128-toolbar-context-menu'

[arvados-workbench2.git] / README.md

diff --git a/README.md b/README.md
index f6a7e48587522f8dcf90592582dd47ca571b14e6..4ec4bd1cf8418b02b62bd31f5058aba22d27536f 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
 ```
 
+## 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
@@ -37,12 +48,12 @@ make integration-tests-in-docker
 ## 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)
-# 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
@@ -71,7 +82,6 @@ Currently this configuration schema is supported:
 ```
 {
     "API_HOST": "string",
-    "VOCABULARY_URL": "string",
     "FILE_VIEWERS_CONFIG_URL": "string",
 }
 ```
@@ -82,12 +92,6 @@ The Arvados base URL.
 
 The `REACT_APP_ARVADOS_API_HOST` environment variable can be used to set the default URL if the run time configuration is unreachable.
 
-### VOCABULARY_URL
-Local path, or any URL that allows cross-origin requests. See
-[Vocabulary JSON file example](public/vocabulary-example.json).
-
-To use the URL defined in the Arvados cluster configuration, remove the entire `VOCABULARY_URL` entry from the runtime configuration. Found in `/config.json` by default.
-
 ## FILE_VIEWERS_CONFIG_URL
 Local path, or any URL that allows cross-origin requests. See: