mirror of
https://github.com/halo-dev/docs.git
synced 2025-10-22 10:58:56 +00:00
docs: update documentation for Halo 2.8 (#238)
为 Halo 2.8.0 更新文档。 /kind documentation ```release-note None ```
This commit is contained in:
122
versioned_docs/version-2.8/developer-guide/core/run.md
Normal file
122
versioned_docs/version-2.8/developer-guide/core/run.md
Normal file
@@ -0,0 +1,122 @@
|
||||
---
|
||||
title: 开发环境运行
|
||||
description: 开发环境运行的指南
|
||||
---
|
||||
|
||||
:::info
|
||||
在此之前,我们推荐你先阅读[《准备工作》](./prepare),检查本地环境是否满足要求。
|
||||
:::
|
||||
|
||||
## 项目结构说明
|
||||
|
||||
目前如果需要完整的运行 Halo,总共需要三个部分:
|
||||
|
||||
1. Halo 主项目([halo-dev/halo](https://github.com/halo-dev/halo))
|
||||
2. Console 控制台(托管在 Halo 主项目)
|
||||
3. 主题(Halo 主项目内已包含默认主题)
|
||||
|
||||
:::info 说明
|
||||
当前 Halo 主项目并不会将 Console 的构建资源托管到 Git 版本控制,所以在开发环境是需要同时运行 Console 项目的。当然,在我们的最终发布版本的时候会在 CI 中自动构建 Console 到 Halo 主项目。
|
||||
:::
|
||||
|
||||
## 克隆项目
|
||||
|
||||
如果你已经 fork 了相关仓库,请将以下命令中的 halo-dev 替换为你的 GitHub 用户名。
|
||||
|
||||
```bash
|
||||
git clone https://github.com/halo-dev/halo
|
||||
|
||||
# 或者使用 ssh 的方式 clone(推荐)
|
||||
|
||||
git clone git@github.com:halo-dev/halo.git
|
||||
```
|
||||
|
||||
:::warning
|
||||
从 2.4.0 开始,Console 项目已经合并到 Halo 主项目,所以不再需要单独克隆 Console 的项目仓库。
|
||||
|
||||
详情可查阅:<https://github.com/halo-dev/halo/issues/3393>
|
||||
:::
|
||||
|
||||
## 运行 Console
|
||||
|
||||
```bash
|
||||
cd path/to/halo
|
||||
```
|
||||
|
||||
Linux / macOS 平台:
|
||||
|
||||
```bash
|
||||
make -C console dev
|
||||
```
|
||||
|
||||
Windows 平台:
|
||||
|
||||
```bash
|
||||
cd console
|
||||
|
||||
pnpm install
|
||||
|
||||
pnpm build:packages
|
||||
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
最终控制台打印了如下信息即代表运行正常:
|
||||
|
||||
```bash
|
||||
VITE v3.1.6 ready in 638 ms
|
||||
|
||||
➜ Local: http://localhost:3000/console/
|
||||
```
|
||||
|
||||
:::info 提示
|
||||
请不要直接使用 Console 的运行端口(3000)访问,会因为跨域问题导致无法正常登录,建议按照后续的步骤以 dev 的配置文件运行 Halo,在 dev 的配置文件中,我们默认代理了 Console 的访问地址,所以后续访问 Console 使用 `http://localhost:8090/console` 访问即可,代理的相关配置:
|
||||
|
||||
```yaml
|
||||
halo:
|
||||
console:
|
||||
proxy:
|
||||
endpoint: http://localhost:3000/
|
||||
enabled: true
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
## 运行 Halo
|
||||
|
||||
1. 在 IntelliJ IDEA 中打开 Halo 项目,等待 Gradle 初始化和依赖下载完成。
|
||||
|
||||
2. 修改 IntelliJ IDEA 的运行配置
|
||||
1. macOS / Linux
|
||||
将 Active Profiles 改为 `dev`,如图所示:
|
||||

|
||||
2. Windows
|
||||
将 Active Profiles 改为 `dev,win`,如图所示:
|
||||

|
||||
|
||||
3. 点击 IntelliJ IDEA 的运行按钮,等待项目启动完成。
|
||||
|
||||
4. 或者使用 Gradle 运行
|
||||
|
||||
```bash
|
||||
# macOS / Linux
|
||||
./gradlew bootRun --args="--spring.profiles.active=dev"
|
||||
|
||||
# Windows
|
||||
gradlew.bat bootRun --args="--spring.profiles.active=dev,win"
|
||||
```
|
||||
|
||||
5. 最终访问 `http://localhost:8090/console` 即可进入控制台。访问 `http://localhost:8090` 即可进入站点首页。
|
||||
|
||||
:::info
|
||||
开发环境下,超级管理员的默认用户名为 `admin`,默认密码为 `admin`。也可通过修改 `application-dev.yaml` 配置文件进行更改:
|
||||
|
||||
```yaml
|
||||
halo:
|
||||
security:
|
||||
initializer:
|
||||
super-admin-username: admin
|
||||
super-admin-password: admin
|
||||
```
|
||||
|
||||
:::
|
Reference in New Issue
Block a user