X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/cf48e928d4d334b0b6434529d7619c616da319f2..a0a722d1920abbe1e20190d296be0c51daabefc2:/README.md diff --git a/README.md b/README.md index bfeb1677ad..55e96af3c1 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,101 @@ +[comment]: # (Copyright © The Arvados Authors. All rights reserved.) +[comment]: # () +[comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0) + ## Arvados Workbench 2 -##### Setup +### Setup
brew install yarn yarn installInstall [redux-devtools-extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) -##### Start project +### Start project
yarn start
-##### Run tests
-yarn test
+### Run unit tests
++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 +
+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. + +Example: +``` +REACT_APP_ARVADOS_CONFIG_URL=config.json yarn build +``` + +### Run time configuration +The app will fetch runtime configuration when starting. By default it will try to fetch `/config.json`. You can customize this url using build time configuration. + +Currently this configuration schema is supported: +``` +{ + "API_HOST": "string", + "VOCABULARY_URL": "string", + "FILE_VIEWERS_CONFIG_URL": "string", +} +``` + +#### 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 +[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: + +[File viewers config file example](public/file-viewers-example.json) + +[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. + +### Licensing -##### Production build -
yarn build
+Arvados is Free Software. See COPYING for information about Arvados Free
+Software licenses.