开发环境运行
信息
在此之前,我们推荐你先阅读《准备工作》,检查本地环境是否满足要求。
项目结构说明
目前如果需要完整的运行 Halo,总共需要三个部分:
- Halo 主项目(halo-dev/halo)
- Console 控制台(halo-dev/console)
- 主题
说明
当前 Halo 主项目并不会将 Console 的构建资源托管到 Git 版本控制,所以在开发环境是需要同时运行 Console 项目的。当然,在我们的最终发布版本的时候会在 CI 中自动构建 Console 到 Halo 主项目。
克隆项目
如果你已经 fork 了相关仓库,请将以下命令中的 halo-dev 替换为你的 GitHub 用户名。
git clone https://github.com/halo-dev/halo
# 或者使用 ssh 的方式 clone(推荐)
git clone git@github.com:halo-dev/halo.git
git clone https://github.com/halo-dev/console
# 或者使用 ssh 的方式 clone(推荐)
git clone git@github.com:halo-dev/console.git
运行 Console
cd path/to/console
pnpm install
pnpm build:packages
pnpm dev
最终控制台打印了如下信息即代表运行正常:
VITE v3.1.6 ready in 638 ms
➜ Local: http://localhost:3000/console/
提示
请不要直接使用 Console 的运行端口(3000)访问,会因为跨域问题导致无法正常登录,建议按照后续的步骤以 dev 的配置文件运行 Halo,在 dev 的配置文件中,我们默认代理了 Console 的访问地址,所以后续访问 Console 使用 http://localhost:8090/console
访问即可,代理的相关配置:
halo:
console:
proxy:
endpoint: http://localhost:3000/
enabled: true
运行 Halo
在 IntelliJ IDEA 中打开 Halo 项目,等待 Gradle 初始化和依赖下载完成。
修改 IntelliJ IDEA 的运行配置
- macOS / Linux
将 Active Profiles 改为
dev
,如图所示: - Windows
将 Active Profiles 改为
dev,win
,如图所示:
- macOS / Linux
将 Active Profiles 改为
点击 IntelliJ IDEA 的运行按钮,等待项目启动完成。
或者使用 Gradle 运行
# macOS / Linux
./gradlew bootRun --args="--spring.profiles.active=dev"
# Windows
gradlew.bat bootRun --args="--spring.profiles.active=dev,win"最终访问
http://localhost:8090/console
即可进入控制台。访问http://localhost:8090
即可进入站点首页。