# VisualDL 前端
[English](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/README.md) | 简体中文
## 使用
> 要求 nodejs ≥ 10 并且 npm ≥ 6
```bash
npm install -g @visualdl/cli
# or
yarn global add @visualdl/cli
```
之后可以启动 VisualDL 服务：
```bash
visualdl start --backend="http://127.0.0.1:8040"
```
要停止 VisualDL 服务：
```bash
visualdl stop
```
更多详情：
```bash
visualdl -h
```
## 开发
```bash
npm install && npm run bootstrap
# or
yarn
```
> 注意：如果你全局安装了 yarn，你不需要运行 bootstrap。因为 yarn 会帮你完成这一步。
## 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)
[netron](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/netron/README.md)
[cli](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/packages/cli/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)
## 编译和部署
> 目前仅支持 Linux/MacOS 上编译。
运行：
```bash
yarn build
```
你会在 `output` 文件夹中得到 `server.tar.gz` 和 `serverless.tar.gz`。
### Server 部署
> 要求 nodejs ≥ 10 并且 npm ≥ 6
解压 `server.tar.gz` 到任何地方。
`cd` 到那个文件夹然后运行：
```bash
npm install --production
```
然后使用：
```bash
npm start
```
来启动生产服务。
### Serverless 部署
解压 `serverless.tar.gz` 到你的 `webroot` 中。
之后即可启动你的 Web 服务器并享受了。
### 浏览器兼容性
VisualDL 支持最新版本的 [Google Chrome](https://www.google.com/chrome/) 和 [Mozilla Firefox](https://www.mozilla.org/) 。 [Microsoft Edge](https://www.microsoft.com/edge) 和 [Apple Safari](https://www.apple.com/safari/) 也许可以工作但是并未经过测试。
## 了解更多
本项目基于以下项目：
- [Next.js](https://nextjs.org/)
- [React](https://reactjs.org/)
- [ECharts](https://echarts.apache.org/)
- [wasm-pack](https://rustwasm.github.io/wasm-pack/)
- [Netron](https://github.com/lutzroeder/netron)
## 作者
## 许可证
[Apache-2.0](https://github.com/PaddlePaddle/VisualDL/blob/develop/LICENSE)
