# VisualDL FrontEnd
English | [简体中文](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/README_cn.md)
**🚧UNDER DEVELOPMENT🚧**
**🚧SOME FEATURE MAY NOT WORK PROPERLY🚧**
**🚧PULL REQUESTS WELCOMED🚧**
## Usage
> nodejs ≥ 10 and npm ≥ 6 are required.
```bash
npm install -g visualdl
# or
yarn global add visualdl
```
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
First, install all dependencies:
```bash
npm install
# or
yarn
```
Then you can start the development server:
```bash
yarn dev
```
Now open [http://localhost:8999](http://localhost:8999) with your browser.
You can change the port with `PORT` environment variable:
```bash
PORT=3000 yarn dev
```
### WebAssembly
WebAssembly is **DISABLED** by default under development environment.
If you want to develop wasm features, you must have [Rust](https://www.rust-lang.org/) and [Cargo](https://doc.rust-lang.org/cargo/) installed.
Using [rustup](https://rustup.rs/) to install them.
Then install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) to build rust code to wasm binaries.
When environment is ready, start the development server with following command:
```bash
yarn dev:wasm
```
## Build & Deploy
```bash
./scripts/build.sh
yarn start
# we are working on deployment now, please wait
```
### 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)
