Merge branch '21128-toolbar-context-menu'

[arvados-workbench2.git] / README.md

diff --git a/README.md b/README.md
index 425d1787848e5b9dad4e077eed23b2f73aea47ea..4ec4bd1cf8418b02b62bd31f5058aba22d27536f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,31 +2,71 @@
 [comment]: # ()
 [comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0)
 
 [comment]: # ()
 [comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0)
 

-## Arvados Workbench 2
+# Arvados Workbench 2

 
 

-### Setup
-<pre>
-brew install yarn
+## Setup
+```
+npm install yarn

 yarn install
 yarn install

-</pre>
+```
+

 Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
 
 Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
 

-### Start project
-<code>yarn start</code>
+## Start project for development
+```
+yarn start
+```

 
 

-### Run tests
-<pre>
-yarn install
-yarn test
-</pre>
+## Start project for development inside Docker container

 
 

-### Production build
-<pre>
+```
+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 install

+yarn start
+```
+
+## 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 build
 yarn build

-</pre>
+```

 
 

-### Build time configuration
+## Package build
+```
+make packages
+```
+
+## Build time configuration

 You can customize project global variables using env variables. Default values are placed in the `.env` file.
 
 Example:
 You can customize project global variables using env variables. Default values are placed in the `.env` file.
 
 Example:


@@ -34,30 +74,41 @@ Example:
 REACT_APP_ARVADOS_CONFIG_URL=config.json yarn build
 ```
 
 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.
+## Run time configuration
+The app will fetch runtime configuration when starting. By default it will try to fetch `/config.json`.  In development mode, this can be found in the `public` directory.
+You can customize this url using build time configuration.

 
 Currently this configuration schema is supported:
 ```
 {
     "API_HOST": "string",
 
 Currently this configuration schema is supported:
 ```
 {
     "API_HOST": "string",

-    "VOCABULARY_URL": "string",

     "FILE_VIEWERS_CONFIG_URL": "string",
 }
 ```
 
     "FILE_VIEWERS_CONFIG_URL": "string",
 }
 ```
 

-#### VOCABULARY_URL
-Local path, or any URL that allows cross-origin requests. See 
-[Vocabulary JSON file example](public/vocabulary-example.json).
+### 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.

 
 

-### FILE_VIEWERS_CONFIG_URL
+## 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)
 
 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)
 

-### Licensing
+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.
+
+## Plugin support
+
+Workbench supports plugins to add new functionality to the user
+interface.  For information about installing plugins, the provided
+example plugins, see [src/plugins/README.md](src/plugins/README.md).
+
+
+## Licensing

 
 Arvados is Free Software. See COPYING for information about Arvados Free
 Software licenses.
 
 Arvados is Free Software. See COPYING for information about Arvados Free
 Software licenses.