From ad9252e32500e68b313baa5c1804e81a00631e11 Mon Sep 17 00:00:00 2001 From: songjianet <1778651752@qq.com> Date: Sun, 27 Feb 2022 22:44:05 +0800 Subject: [PATCH] [Docs][UI Next] Update README. (#8560) * [Docs][UI Next] Update README. * Update README.md --- dolphinscheduler-ui-next/README.md | 56 ++++++++++++++++++++++++------ 1 file changed, 46 insertions(+), 10 deletions(-) diff --git a/dolphinscheduler-ui-next/README.md b/dolphinscheduler-ui-next/README.md index b3ae5bd74f..7b43cd0e5b 100644 --- a/dolphinscheduler-ui-next/README.md +++ b/dolphinscheduler-ui-next/README.md @@ -1,14 +1,50 @@ -### Dolphin Scheduler UI Next +# Dolphin Scheduler UI Next -#### start +--- -Please make sure you use `node 16+` and `pnpm` to manage the dependencies of the project. +> After two and a half months of development cycle, we have brought a brand-new `UI` management system (V1.0.0-Alpha). +> +> Compared with the old `UI`, it will be more standardized, and it will also have a more complete type checking mechanism. At the same time, its speed has made a qualitative leap. +> +> We also provide dark mode and light mode to meet the preferences of different developers. It will make your eyes shine. +> +> If you have tried the new `UI` and found problems in use, you can contact us through issue. -#### e2e list +--- -- [login](https://github.com/apache/dolphinscheduler/tree/dev/dolphinscheduler-ui-next/docs/e2e/login.md) -- [data-source](https://github.com/apache/dolphinscheduler/tree/dev/dolphinscheduler-ui-next/docs/e2e/data-source.md) -- [navbar](https://github.com/apache/dolphinscheduler/tree/dev/dolphinscheduler-ui-next/docs/e2e/navbar.md) -- [project](https://github.com/apache/dolphinscheduler/tree/dev/dolphinscheduler-ui-next/docs/e2e/project.md) -- [resource](https://github.com/apache/dolphinscheduler/tree/dev/dolphinscheduler-ui-next/docs/e2e/resource.md) -- [security](https://github.com/apache/dolphinscheduler/tree/dev/dolphinscheduler-ui-next/docs/e2e/security.md) +### Start Using + +For the best experience, we recommend using `node 16.x.x` and `pnpm 6.x.x`. +You can learn how to install the corresponding version from their official website. + +- [node](https://nodejs.org/en/) +- [pnpm](https://pnpm.io/) + +#### Install Dependencies + +```shell +pnpm install +``` + + +#### Start Development Project + +To do this you need to change the `VITE_APP_DEV_WEB_URL` parameter variable in `.env.development` in the project root directory. + +It is worth noting that when you do not change the request path or route, you only need to write `http`, `ip` and `port` without the `/` symbol at the end, such as `http://127.0. 0.1:12345`. + +```shell +pnpm run dev +``` + +#### Build Project + +We provide two packaging and compilation environments by default, `development` and `production`. Their interface request configurations are in `.env.development` and `.env.production` in the project root directory respectively. Please change the `URL` is the address of the corresponding backend service. + +```shell +pnpm run build:dev +# or +pnpm run build:prod +``` + +---