# VisualDL FrontEnd
English | [简体中文](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/README_cn.md)
## Usage
> nodejs ≥ 10 and npm ≥ 6 are required.
```bash
npm install -g @visualdl/cli
# or
yarn global add @visualdl/cli
```
Then you can start VisualDL server by
```bash
visualdl start --backend="http://127.0.0.1:8040"
```
To stop VisualDL server, just type
```bash
visualdl stop
```
For more usage infomation, please type
```bash
visualdl -h
```
## Development
```bash
npm install && npm run bootstrap
# or
yarn
```
> Notice: if you have yarn installed globally, you don't need to bootstrap because yarn workspace will do it for you.
## Packages
[core](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/core/README.md)
[server](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/server/README.md)
[serverless](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/serverless/README.md)
[cli](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/cli/README.md)
[i18n](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/i18n/README.md)
[wasm](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/wasm/README.md)
[mock](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/mock/README.md)
## Build & Deploy
> We only support building on Linux/MacOS now.
Run:
```bash
yarn build
```
You will get `server.tar.gz` and `serverless.tar.gz` in `output` directory.
### Server deployment
> nodejs ≥ 10 and npm ≥ 6 are required.
Extract `server.tar.gz` to wherever you want.
`cd` into the directory and run:
```bash
npm install --production
```
Then use:
```bash
npm start
```
to start a production server.
### Serverless deployment
Extract `serverless.tar.gz` to your `webroot`.
Just start your web server and enjoy.
### Browser Compatibility
VisualDL supports the latest version of [Google Chrome](https://www.google.com/chrome/) and [Mozilla Firefox](https://www.mozilla.org/). [Microsoft Edge](https://www.microsoft.com/edge) and [Apple Safari](https://www.apple.com/safari/) may work too but are not tested.
## Learn More
This project is based on following projects:
- [Next.js](https://nextjs.org/)
- [React](https://reactjs.org/)
- [ECharts](https://echarts.apache.org/)
- [wasm-pack](https://rustwasm.github.io/wasm-pack/)
## Author
## License
[Apache-2.0](https://github.com/PaddlePaddle/VisualDL/blob/develop/LICENSE)
