docs: update documentation for development (#284)

更新开发环境运行文档,补充关于 UC 个人中心的描述。

/kind documentation

Fixes https://github.com/halo-dev/docs/issues/278

```release-note
None
```
wan92hen-patch-1
Ryan Wang 1 year ago committed by GitHub
parent df6ed25a8e
commit 11a4d97602
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -31,13 +31,7 @@ git checkout v2.4.0
请务必按照以上要求切换到最新的 tag而不是直接使用 main 分支构建main 分支是我们的开发分支。此文档以 `2.11.0` 为例,查看最新的 tag 可使用 `git tag --column` 查看。 请务必按照以上要求切换到最新的 tag而不是直接使用 main 分支构建main 分支是我们的开发分支。此文档以 `2.11.0` 为例,查看最新的 tag 可使用 `git tag --column` 查看。
::: :::
:::warning ## 构建 Console 和个人中心
从 2.4.0 开始Console 项目已经合并到 Halo 主项目,所以不再需要单独克隆 Console 的项目仓库。
详情可查阅:<https://github.com/halo-dev/halo/issues/3393>
:::
## 构建 Console
```bash ```bash
cd path/to/halo cd path/to/halo

@ -7,7 +7,7 @@ description: 开发环境的准备工作
- [OpenJDK 17 LTS](https://github.com/openjdk/jdk) - [OpenJDK 17 LTS](https://github.com/openjdk/jdk)
- [Node.js 18 LTS](https://nodejs.org) - [Node.js 18 LTS](https://nodejs.org)
- [pnpm 7](https://pnpm.io/) - [pnpm 8](https://pnpm.io/)
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) - [IntelliJ IDEA](https://www.jetbrains.com/idea/)
- [Git](https://git-scm.com/) - [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/)(可选) - [Docker](https://www.docker.com/)(可选)

@ -12,11 +12,13 @@ description: 开发环境运行的指南
目前如果需要完整的运行 Halo总共需要三个部分 目前如果需要完整的运行 Halo总共需要三个部分
1. Halo 主项目([halo-dev/halo](https://github.com/halo-dev/halo) 1. Halo 主项目([halo-dev/halo](https://github.com/halo-dev/halo)
2. Console 控制台(托管在 Halo 主项目) 2. UI包括 Console 控制台和 UC 个人中心(托管在 Halo 主项目)
3. 主题Halo 主项目内已包含默认主题) 3. 主题Halo 主项目内已包含默认主题)
:::info 说明 :::info 说明
当前 Halo 主项目并不会将 Console 的构建资源托管到 Git 版本控制,所以在开发环境是需要同时运行 Console 项目的。当然,在我们的最终发布版本的时候会在 CI 中自动构建 Console 到 Halo 主项目。 从 Halo 2.11 开始Halo 项目的 console 目录同时包含了 Console管理控制台和 UC个人中心以下统称为 UI。
当前 Halo 主项目并不会将 UI 的构建资源托管到 Git 版本控制,所以在开发环境是需要同时运行 UI 项目的。当然,在我们的最终发布版本的时候会在 CI 中自动构建 UI 到 Halo 主项目。
::: :::
## 克隆项目 ## 克隆项目
@ -31,13 +33,7 @@ git clone https://github.com/halo-dev/halo
git clone git@github.com:halo-dev/halo.git git clone git@github.com:halo-dev/halo.git
``` ```
:::warning ## 运行 UI 服务
从 2.4.0 开始Console 项目已经合并到 Halo 主项目,所以不再需要单独克隆 Console 的项目仓库。
详情可查阅:<https://github.com/halo-dev/halo/issues/3393>
:::
## 运行 Console
```bash ```bash
cd path/to/halo cd path/to/halo
@ -64,13 +60,17 @@ pnpm dev
最终控制台打印了如下信息即代表运行正常: 最终控制台打印了如下信息即代表运行正常:
```bash ```bash
VITE v3.1.6 ready in 638 ms VITE v4.2.3 ready in 638 ms
# Console 控制台服务
➜ Local: http://localhost:3000/console/ ➜ Local: http://localhost:3000/console/
# UC 个人中心服务
➜ Local: http://localhost:4000/uc/
``` ```
:::info 提示 :::info 提示
请不要直接使用 Console 的运行端口3000访问会因为跨域问题导致无法正常登录建议按照后续的步骤以 dev 的配置文件运行 Halo在 dev 的配置文件中,我们默认代理了 Console 的访问地址,所以后续访问 Console 使用 `http://localhost:8090/console` 访问即可,代理的相关配置: 请不要直接使用 UI 的运行端口3000 / 4000访问会因为跨域问题导致无法正常登录建议按照后续的步骤以 dev 的配置文件运行 Halo在 dev 的配置文件中,我们默认代理了 UI 页面的访问地址,所以后续访问 UI 页面使用 `http://localhost:8090/console``http://localhost:8090/uc` 访问即可,代理的相关配置:
```yaml ```yaml
halo: halo:
@ -78,6 +78,10 @@ halo:
proxy: proxy:
endpoint: http://localhost:3000/ endpoint: http://localhost:3000/
enabled: true enabled: true
uc:
proxy:
endpoint: http://localhost:4000/
enabled: true
``` ```
::: :::
@ -121,4 +125,7 @@ halo:
gradlew.bat bootRun --args="--spring.profiles.active=dev,win" gradlew.bat bootRun --args="--spring.profiles.active=dev,win"
``` ```
6. 最终访问 `http://localhost:8090/console` 即可进入控制台。访问 `http://localhost:8090` 即可进入站点首页。 6. 最终提供以下访问地址:
1. 网站首页:<http://localhost:8090>
2. Console 控制台:<http://localhost:8090/console>
3. UC 个人中心:<http://localhost:8090/uc>

@ -31,13 +31,7 @@ git checkout v2.4.0
请务必按照以上要求切换到最新的 tag而不是直接使用 main 分支构建main 分支是我们的开发分支。此文档以 `2.11.0` 为例,查看最新的 tag 可使用 `git tag --column` 查看。 请务必按照以上要求切换到最新的 tag而不是直接使用 main 分支构建main 分支是我们的开发分支。此文档以 `2.11.0` 为例,查看最新的 tag 可使用 `git tag --column` 查看。
::: :::
:::warning ## 构建 Console 和个人中心
从 2.4.0 开始Console 项目已经合并到 Halo 主项目,所以不再需要单独克隆 Console 的项目仓库。
详情可查阅:<https://github.com/halo-dev/halo/issues/3393>
:::
## 构建 Console
```bash ```bash
cd path/to/halo cd path/to/halo

@ -7,7 +7,7 @@ description: 开发环境的准备工作
- [OpenJDK 17 LTS](https://github.com/openjdk/jdk) - [OpenJDK 17 LTS](https://github.com/openjdk/jdk)
- [Node.js 18 LTS](https://nodejs.org) - [Node.js 18 LTS](https://nodejs.org)
- [pnpm 7](https://pnpm.io/) - [pnpm 8](https://pnpm.io/)
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) - [IntelliJ IDEA](https://www.jetbrains.com/idea/)
- [Git](https://git-scm.com/) - [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/)(可选) - [Docker](https://www.docker.com/)(可选)

@ -12,11 +12,13 @@ description: 开发环境运行的指南
目前如果需要完整的运行 Halo总共需要三个部分 目前如果需要完整的运行 Halo总共需要三个部分
1. Halo 主项目([halo-dev/halo](https://github.com/halo-dev/halo) 1. Halo 主项目([halo-dev/halo](https://github.com/halo-dev/halo)
2. Console 控制台(托管在 Halo 主项目) 2. UI包括 Console 控制台和 UC 个人中心(托管在 Halo 主项目)
3. 主题Halo 主项目内已包含默认主题) 3. 主题Halo 主项目内已包含默认主题)
:::info 说明 :::info 说明
当前 Halo 主项目并不会将 Console 的构建资源托管到 Git 版本控制,所以在开发环境是需要同时运行 Console 项目的。当然,在我们的最终发布版本的时候会在 CI 中自动构建 Console 到 Halo 主项目。 从 Halo 2.11 开始Halo 项目的 console 目录同时包含了 Console管理控制台和 UC个人中心以下统称为 UI。
当前 Halo 主项目并不会将 UI 的构建资源托管到 Git 版本控制,所以在开发环境是需要同时运行 UI 项目的。当然,在我们的最终发布版本的时候会在 CI 中自动构建 UI 到 Halo 主项目。
::: :::
## 克隆项目 ## 克隆项目
@ -31,13 +33,7 @@ git clone https://github.com/halo-dev/halo
git clone git@github.com:halo-dev/halo.git git clone git@github.com:halo-dev/halo.git
``` ```
:::warning ## 运行 UI 服务
从 2.4.0 开始Console 项目已经合并到 Halo 主项目,所以不再需要单独克隆 Console 的项目仓库。
详情可查阅:<https://github.com/halo-dev/halo/issues/3393>
:::
## 运行 Console
```bash ```bash
cd path/to/halo cd path/to/halo
@ -64,13 +60,17 @@ pnpm dev
最终控制台打印了如下信息即代表运行正常: 最终控制台打印了如下信息即代表运行正常:
```bash ```bash
VITE v3.1.6 ready in 638 ms VITE v4.2.3 ready in 638 ms
# Console 控制台服务
➜ Local: http://localhost:3000/console/ ➜ Local: http://localhost:3000/console/
# UC 个人中心服务
➜ Local: http://localhost:4000/uc/
``` ```
:::info 提示 :::info 提示
请不要直接使用 Console 的运行端口3000访问会因为跨域问题导致无法正常登录建议按照后续的步骤以 dev 的配置文件运行 Halo在 dev 的配置文件中,我们默认代理了 Console 的访问地址,所以后续访问 Console 使用 `http://localhost:8090/console` 访问即可,代理的相关配置: 请不要直接使用 UI 的运行端口3000 / 4000访问会因为跨域问题导致无法正常登录建议按照后续的步骤以 dev 的配置文件运行 Halo在 dev 的配置文件中,我们默认代理了 UI 页面的访问地址,所以后续访问 UI 页面使用 `http://localhost:8090/console``http://localhost:8090/uc` 访问即可,代理的相关配置:
```yaml ```yaml
halo: halo:
@ -78,6 +78,10 @@ halo:
proxy: proxy:
endpoint: http://localhost:3000/ endpoint: http://localhost:3000/
enabled: true enabled: true
uc:
proxy:
endpoint: http://localhost:4000/
enabled: true
``` ```
::: :::
@ -121,4 +125,7 @@ halo:
gradlew.bat bootRun --args="--spring.profiles.active=dev,win" gradlew.bat bootRun --args="--spring.profiles.active=dev,win"
``` ```
6. 最终访问 `http://localhost:8090/console` 即可进入控制台。访问 `http://localhost:8090` 即可进入站点首页。 6. 最终提供以下访问地址:
1. 网站首页:<http://localhost:8090>
2. Console 控制台:<http://localhost:8090/console>
3. UC 个人中心:<http://localhost:8090/uc>

Loading…
Cancel
Save