membphis commented on a change in pull request #729:
URL: https://github.com/apache/apisix-dashboard/pull/729#discussion_r519534099
##########
File path: Makefile
##########
@@ -17,26 +17,68 @@
SHELL := /bin/bash -o pipefail
UNAME ?= $(shell uname)
+YARN_EXEC ?= $(shell which yarn)
+GO_EXEC ?= $(shell which go)
-### help: Show Makefile rules
+export GO111MODULE=on
+
+### help: Show Makefile rules
.PHONY: help
help:
@echo Makefile rules:
@echo
@grep -E '^### [-A-Za-z0-9_]+:' Makefile | sed 's/###/ /'
-export GO111MODULE=on
-### license-check: Check apisix-dashboard source codes for Apache License
-.PHONY: license-check
-license-check:
-ifeq ("$(wildcard .actions/openwhisk-utilities/scancode/scanCode.py)", "")
- git clone https://github.com/apache/openwhisk-utilities.git
.actions/openwhisk-utilities
- cp .actions/ASF* .actions/openwhisk-utilities/scancode/
+### build: build dashboard, it contains web and manager-api
+.PHONY: build
+build: web-default api-default
+ api/build.sh; \
+ cd /web; \
Review comment:
another style: `cd /web && yarn install && yarn build`
##########
File path: docs/deploy.md
##########
@@ -27,7 +27,9 @@ $ git clone -b v2.0
https://github.com/apache/apisix-dashboard.git
$ cd apisix-dashboard
```
-## Build the manager-api
+## build
+
+### checklist for manager-api
Review comment:
`manager-api dependencies`
##########
File path: docs/deploy.md
##########
@@ -37,51 +39,32 @@ NOTE: You also need to install `Lua` 5.1+ if you want to
use the Plugin Orchestr
2. Check environment variables
-- enable Go MODULE
-
-```sh
-$ go env -w GO111MODULE=on
-```
-
- For most users in China, we could use [Goproxy](https://goproxy.cn/) to
speed up downloading modules.
```sh
$ go env -w GOPROXY=https://goproxy.cn,direct
```
-3. Build
-
-```sh
-$ api/build.sh
-```
-
The bundled files are located in the root directory `/output`.
-## Build the web
+### checklist for web
Review comment:
`web dependencies` is better
##########
File path: Makefile
##########
@@ -17,26 +17,68 @@
SHELL := /bin/bash -o pipefail
UNAME ?= $(shell uname)
+YARN_EXEC ?= $(shell which yarn)
+GO_EXEC ?= $(shell which go)
-### help: Show Makefile rules
+export GO111MODULE=on
+
+### help: Show Makefile rules
.PHONY: help
help:
@echo Makefile rules:
@echo
@grep -E '^### [-A-Za-z0-9_]+:' Makefile | sed 's/###/ /'
-export GO111MODULE=on
-### license-check: Check apisix-dashboard source codes for Apache License
-.PHONY: license-check
-license-check:
-ifeq ("$(wildcard .actions/openwhisk-utilities/scancode/scanCode.py)", "")
- git clone https://github.com/apache/openwhisk-utilities.git
.actions/openwhisk-utilities
- cp .actions/ASF* .actions/openwhisk-utilities/scancode/
+### build: build dashboard, it contains web and manager-api
+.PHONY: build
+build: web-default api-default
+ api/build.sh; \
+ cd /web; \
+ yarn install; \
+ yarn build
+
+
+### run: run dashboard, it contains web and manager-api
+.PHONY: run
+run:
+ api/run.sh &
Review comment:
I think we implement the `run` and `stop` later ^_^
`api-run`, `api-stop` is enough currently.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
