README.md 856 Bytes
Newer Older
fishyds's avatar
fishyds committed
1
# WebUI
Deshui Yu's avatar
Deshui Yu committed
2

3
WebUI is built by using [React](https://reactjs.org/docs/getting-started.html) and [fluentui](https://developer.microsoft.com/en-us/fluentui#/controls/web).
Deshui Yu's avatar
Deshui Yu committed
4
5


6
## Development
Deshui Yu's avatar
Deshui Yu committed
7

8
* Please refer the [installation doc](https://github.com/microsoft/nni#installation) to run an experiment.
Deshui Yu's avatar
Deshui Yu committed
9

Lijiaoa's avatar
Lijiaoa committed
10
* Use this command in `webui/ts` directory when you change webui code. And then refresh website to see latest pages.
11
12
13
    ```bash
    yarn build
    ```
Deshui Yu's avatar
Deshui Yu committed
14

15
## PR
Deshui Yu's avatar
Deshui Yu committed
16

Lijiaoa's avatar
Lijiaoa committed
17
* WebUI uses [eslint](https://eslint.org/docs/user-guide/getting-started) and [prettier](https://prettier.io/docs/en/index.html) to format code. You could use the command `yarn sanity-check` to check the code error status. And use `yarn sanity-check --fix` could modifiy the most code style error before you send PR.
Lijiaoa's avatar
Lijiaoa committed
18
19

* You could send the PR if `yarn release` gets successful build after formatting code.