X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/de9713360b5bc04dc3586b332bc98db5d97650a5..b7eb7d60846333d93e91f98ec3e6fcdd94fca570:/README.md?ds=sidebyside diff --git a/README.md b/README.md index bca04b1ed3..55e96af3c1 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,32 @@ Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/red ### Start project yarn start -### Run tests +### Run unit tests
-yarn install
-yarn test
+make unit-tests
+
+ +### Run end-to-end tests + +
+make integration-tests
+
+ +### Run end-to-end tests in a Docker container + +
+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
+(inside container)
+# yarn run cypress install
+# tools/run-integration-tests.sh -i -a /usr/src/arvados
 
### Production build @@ -26,6 +48,12 @@ yarn install yarn build +### Package build +
+make workbench2-build-image
+docker run -v$PWD:$PWD -w $PWD arvados/fpm make packages
+
+ ### Build time configuration You can customize project global variables using env variables. Default values are placed in the `.env` file. @@ -46,11 +74,17 @@ Currently this configuration schema is supported: } ``` +#### API_HOST + +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 +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. +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: @@ -59,7 +93,7 @@ Local path, or any URL that allows cross-origin requests. See: [File viewers config scheme](src/models/file-viewers-config.ts) -To use the URL defined in the Arvados cluster configuration, remove the entire FILE_VIEWERS_CONFIG_URL entry from the runtime configuration. Found in `/config.json` by default. +To use the URL defined in the Arvados cluster configuration, remove the entire `FILE_VIEWERS_CONFIG_URL` entry from the runtime configuration. Found in `/config.json` by default. ### Licensing