This is an automated email from the ASF dual-hosted git repository.
min pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-dubbo-ops.git
The following commit(s) were added to refs/heads/develop by this push:
new a45e12e update README
a45e12e is described below
commit a45e12e8a166fd3e9a0b10aebaa6e8963c6e55c1
Author: nzomkxia <[email protected]>
AuthorDate: Mon Oct 29 15:08:56 2018 +0800
update README
---
README.md | 47 ++++------------------
README_ZH.md | 40 +++---------------
.../src/main/resources/application.properties | 20 ---------
3 files changed, 13 insertions(+), 94 deletions(-)
diff --git a/README.md b/README.md
index bf48549..dafe58f 100644
--- a/README.md
+++ b/README.md
@@ -16,62 +16,31 @@
### Backend
-* Configuration files
-
-> - `application.properties`
-> The generic configuration, shared by `application-develop.properties` and
`application-production.properties`
-> - `application-production.properties` (default)
-> The configuration for production
-> - `application-develop.properties`
-> The configuration for develop
->
+* Standard spring boot project
### Production Setup
-1. Clone source code on develop branch
+1. Clone source code on develop branch `git clone
https://github.com/apache/incubator-dubbo-ops.git`
2. Specify registry address in
`dubbo-admin-backend/src/resources/application-production.properties`
3. Build
- * select configuration files via command line
-
- > - `mvn clean package -Pproduction` will active production
configuration(`application-production.properties`)
- > - `mvn clean package -Ddevelop` will active develop
configuration(`application-develop.properties`)
+ > - `mvn clean package`
4. Start `mvn --projects dubbo-admin-backend spring-boot:run`
5. Visit `http://localhost:8080`
---
### Development Setup
-* Configuration in IDE
-
- * Select configuration files in Intellij Idea
-
- 1. Choose profile file during project importing
- 1. In the **Import from Maven** page where IntelliJ IDEA displays the
profiles, select `develop` maven profile:
-
- 2. Select **Next** and finish import
-
- 2. Choose profile file in the Maven Projects tool window to activate
profiles.
- 1. Open the Maven Projects tool window.
- 2. Click the Profiles node to open a list of declared profiles.
- 3. Select the appropriate checkboxes to activate `develop` maven
profile.
-
- * Select configuration files in Eclipse
- 1. import project
- 2. In **Project Explorer**, right click `dubbo-admin-backend`
- 3. Choose **Maven**->**Select Maven Profiles**
- 4. Select `develop` maven profile
-
* Run backend project
backend is a standard spring boot project, you can run it in any java IDE
* Run frontend project
- run with `npm run dev`
-* visit webpage
+ run with `npm run dev`.
+* visit web page
visit `http://localhost:8081`, frontend supports hot reload.
- * CORS problem
- for convenien of development, we deploy frontend and backend separately,
so the frontend supports hot reload. In this mode, frontend will request
`localhost:8080` to fetch data, this will cause a CORS problem, so we add a
configuration in `I18nConfig.java` to support CORS, this configuration will
only be active under **develop** mode, please select the right maven profile to
support this.
+ * CORS problem
+ for the convenience of development, we deploy frontend and backend
separately, so the frontend supports hot reload. In this mode, frontend will
request `localhost:8080` to fetch data, this will cause a CORS problem, so we
add a configuration in `dubbo-admin-frontend/config/index.js` to support CORS.
this config will activated under `npm run dev` mode.
-### Swagger supoort
+### Swagger support
Once deployed, you can check http://localhost:8080/swagger-ui.html to check
all restful api and models
diff --git a/README_ZH.md b/README_ZH.md
index 244a6c0..4caef5a 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -17,15 +17,7 @@ English version goes [here](README.md).
### 后端部分
-* 配置文件
-
-> - `application.properties`
-> 公共配置文件
-> - `application-production.properties` (默认配置)
-> 生产环境的配置文件
-> - `application-develop.properties`
-> 开发环境的配置文件
->
+* 标准spring boot工程
### 生产环境配置
@@ -34,42 +26,20 @@ English version goes [here](README.md).
2. 在
`dubbo-admin-backend/src/resources/application-production.properties`中指定注册中心地址
3. 构建
- * 通过命令行来指定maven active file
-
- > - `mvn clean package -Pproduction`
激活生产环境的配置文件(`application-production.properties`)
+ > - `mvn clean package`
4. 启动 `mvn --projects dubbo-admin-backend spring-boot:run`
5. 访问 `http://localhost:8080`
---
### 开发环境配置
-* IDE设置
-
- * 在Intellij Idea中选择maven profile配置文件
-
- 1. 在引入项目时选择配置文件
- 1. 在 **Import from Maven** 页面，激活`develop`配置文件:
-
- 2. 选择 **Next** 完成项目引入
-
- 2. 在Maven项目工具窗口中选择需要激活的maven profile文件。
- 1. 打开Maven项目工具窗口。
- 2. 点击`Profiles`节点。
- 3. 点击选择`develop`配置文件。
-
- * 在Eclipse中选择maven profile配置文件
- 1. 引入项目
- 2. 在 **Project Explorer**视图中, 右键单击 `dubbo-admin-backend`模块。
- 3. 选择 **Maven**->**Select Maven Profiles**。
- 4. 选择`develop`配置文件。
-
* 运行`dubbo admin backend`
`dubbo admin backend`是一个标准的spring boot项目, 可以在任何java IDE中运行它
* 运行`dubbo admin frontend`
`dubbo admin frontend`由npm管理和构建，在开发环境中，可以单独运行: `npm run dev`
-* 页面访问
+* 页面访问
访问 `http://localhost:8081`, 由于前后端分开部署，前端支持热加载，任何页面的修改都可以实时反馈，不需要重启应用。
- * 跨域问题
- 为了方便开发，我们提供了这种前后端分离的部署模式，主要的好处是支持前端热部署，在这种模式下，前端会通过8080端口访问后端的restful
api接口，获取数据, 这将导致跨域访问的问题。因此我们在`I18nConfig.java`添加了支持跨域访问的配置。这些配置只在**develop**
模式中生效，因此在开发环境中，请选择`develop`配置文件。
+ * 跨域问题
+ 为了方便开发，我们提供了这种前后端分离的部署模式，主要的好处是支持前端热部署，在这种模式下，前端会通过8080端口访问后端的restful
api接口，获取数据,
这将导致跨域访问的问题。因此我们在`dubbo-admin-frontend/config/index.js`添加了支持跨域访问的配置,当前端通过`npm
run dev`单独启动时，这些配置将被激活，允许跨域访问
### Swagger 支持
diff --git a/dubbo-admin-backend/src/main/resources/application.properties
b/dubbo-admin-backend/src/main/resources/application.properties
deleted file mode 100644
index 26cc917..0000000
--- a/dubbo-admin-backend/src/main/resources/application.properties
+++ /dev/null
@@ -1,20 +0,0 @@
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-spring.root.password=root
-spring.guest.password=guest
-spring.profiles.active=@activeProfile@
\ No newline at end of file
