Merge branch 'master' into 13765-information-inside-details-panel
[arvados-workbench2.git] / 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 <pre>
9 brew install yarn
10 yarn install
11 </pre>
12 Install [redux-devtools-extension](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd)
13
14 ### Start project
15 <code>yarn start</code>
16
17 ### Run tests
18 <pre>
19 yarn install
20 yarn test
21 </pre>
22
23 ### Production build
24 <pre>
25 yarn install
26 yarn build
27 </pre>
28
29 ### Configuration
30 You can customize project global variables using env variables. Default values are placed in the `.env` file.
31
32 Example:
33 ```
34 REACT_APP_ARVADOS_API_HOST=localhost:8000 yarn start
35 ```
36
37 ### Licensing
38
39 Arvados is Free Software. See COPYING for information about Arvados Free
40 Software licenses.