diff --git a/dashboard/README.md b/dashboard/README.md index e8f207808..b47c064f1 100644 --- a/dashboard/README.md +++ b/dashboard/README.md @@ -1,31 +1,68 @@ -# Vela Dashboard +# KubeVela Dashboard + +## Quick start + +In the root folder of this project, run `make start-dashboard` to start backend OpenAPI server and Dashboard at the same time. + +```shell +➜ xxx/src/github.com/oam-dev/kubevela $ make start-dashboard +go run pkg/server/main/startAPIServer.go & +cd dashboard && yarn && yarn start && cd .. +yarn install v1.22.4 +warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json. +[1/5] 🔍 Validating package.json... +[2/5] 🔍 Resolving packages... +success Already up-to-date. +$ umi g tmp +✨ Done in 5.89s. +yarn run v1.22.4 +$ umi dev +Starting the development server... +I1230 10:37:54.157092 14236 request.go:621] Throttling request took 1.04915427s, request: GET:https://47.242.145.141:6443/apis/split.smi-spec.io/v1alpha2?timeout=32s +[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production. + - using env: export GIN_MODE=release + - using code: gin.SetMode(gin.ReleaseMode) + +[GIN-debug] POST /api/envs/ --> github.com/oam-dev/kubevela/pkg/server.(*APIServer).CreateEnv-fm (6 handlers) +[GIN-debug] PUT /api/envs/:envName --> github.com/oam-dev/kubevela/pkg/server.(*APIServer).UpdateEnv-fm (6 handlers) +... +[GIN-debug] GET /api/version --> github.com/oam-dev/kubevela/pkg/server.(*APIServer).GetVersion-fm (6 handlers) +[GIN-debug] GET /swagger/*any --> github.com/swaggo/gin-swagger.CustomWrapHandler.func1 (7 handlers) + +✔ Webpack + Compiled successfully in 26.86s + + DONE Compiled successfully in 26865ms 10:38:22 AM -## Environment Prepare + App running at: + - Local: http://localhost:8000 (copied to clipboard) + - Network: http://192.168.31.114:8000 +``` -Install `node_modules`: +## Development + +### Install dependencies ```bash yarn ``` -## Provided Scripts - -Scripts provided in `package.json`. It's safe to modify or add additional script: - -### Start project - -```bash -yarn start -``` - -### Build project +### Build ```bash yarn build ``` -### Check code style +### Start up + +```bash +yarn start +``` + +### Lint and Test + +- Check code style ```bash yarn lint @@ -34,11 +71,11 @@ yarn lint You can also use script to auto fix some lint error: ```bash -yarn lint:fix +yarn prettier ``` -### Test code +- Test code ```bash yarn test -``` \ No newline at end of file +```