22207: fixed layout shift in project view
[arvados.git] / services / workbench2 / README.md
1 [comment]: # (Copyright © The Arvados Authors. All rights reserved.)
2 [comment]: # ()
3 [comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0)
4
5 # Arvados Workbench 2
6
7 ## Setup
8 ```
9 npm install yarn
10 yarn install
11 ```
12
13 Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
14
15 ## Start project for development
16 ```
17 yarn start
18 ```
19
20 ## Start project for development inside Docker container
21
22 ```
23 make workbench2-build-image
24 # (create public/config.json, see "Run time configuration" below)
25 docker run -ti -v$PWD:$PWD -p 3000:3000 -w$PWD workbench2-build /bin/bash
26 # (inside docker container)
27 yarn install
28 yarn start
29 ```
30
31 ## Run unit tests
32 ```
33 make unit-tests
34 ```
35
36 ## Run end-to-end tests
37
38 ```
39 make integration-tests
40 ```
41
42 ## Run end-to-end tests in a Docker container
43
44 ```
45 make integration-tests-in-docker
46 ```
47
48 ## Run tests interactively in container
49
50 ```
51 xhost +local:root
52 docker run -ti -v$PWD:$PWD -v$(realpath ../..):/usr/src/arvados -w$PWD --env="DISPLAY" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" workbench2-build /bin/bash
53 (inside container)
54 yarn run cypress install
55 tools/run-integration-tests.sh -i -a /usr/src/arvados
56 ```
57
58 ## Production build
59 ```
60 yarn build
61 ```
62
63 ## Package build
64 ```
65 make packages
66 ```
67
68 ## Build time configuration
69 You can customize project global variables using env variables. Default values are placed in the `.env` file.
70
71 Example:
72 ```
73 REACT_APP_ARVADOS_CONFIG_URL=config.json yarn build
74 ```
75
76 ## Run time configuration
77 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.
78 You can customize this url using build time configuration.
79
80 Currently this configuration schema is supported:
81 ```
82 {
83     "API_HOST": "string",
84     "FILE_VIEWERS_CONFIG_URL": "string",
85 }
86 ```
87
88 ### API_HOST
89
90 The Arvados base URL.
91
92 The `REACT_APP_ARVADOS_API_HOST` environment variable can be used to set the default URL if the run time configuration is unreachable.
93
94 ## FILE_VIEWERS_CONFIG_URL
95 Local path, or any URL that allows cross-origin requests. See:
96
97 [File viewers config file example](public/file-viewers-example.json)
98
99 [File viewers config scheme](src/models/file-viewers-config.ts)
100
101 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.
102
103 ## Plugin support
104
105 Workbench supports plugins to add new functionality to the user
106 interface.  For information about installing plugins, the provided
107 example plugins, see [src/plugins/README.md](src/plugins/README.md).
108
109
110 ## Licensing
111
112 Arvados is Free Software. See COPYING for information about Arvados Free
113 Software licenses.