整理 clean 目录结构说明和忽略规则

This commit is contained in:
cat-shark
2026-06-20 18:36:36 +08:00
parent b6f30a838f
commit 028d407a78
4 changed files with 134 additions and 22 deletions
+32
View File
@@ -48,6 +48,27 @@ http://127.0.0.1:3302/admin/?api=http://127.0.0.1:3302
npm.cmd run start:check
```
## 打包客户端
客户端安装包不包含本地认证服务和管理后台,只会连接你指定的认证服务地址。
```bat
npm.cmd run build:client:win -- --auth-url=https://auth.example.com
```
本地测试可以先只打包目录,速度更快:
```bat
npm.cmd run build:client:win -- --auth-url=http://127.0.0.1:3302 --dir
```
说明:
- `--auth-url` 可以带或不带 `/api`,脚本会自动规范化。
- 打包时会把该地址注入客户端默认配置。
- 运行时仍可通过环境变量 `AUTH_SERVER_URL` 覆盖认证服务地址。
- 打包配置已排除 `server/``admin-panel/``scripts/local-auth-server.cjs``local-auth-data/`
## 系统 API Key 配置
进入 `http://127.0.0.1:3302/admin/` 后,在“系统配置”里填写:
@@ -57,3 +78,14 @@ npm.cmd run start:check
- 其他 OSS、RunningHub、火山引擎、云美颜配置也可以在这里维护
这些配置会通过 `/api/system/config/public` 提供给本地应用作为兜底配置。
## 目录结构约定
clean 目录就是后续入库的项目根目录;外层 `aIzhinengti` 只作为临时整理和参考目录。
- 源码放在 `src/``electron/``server/``admin-panel/`
- 打包相关资源统一放在 `packaging/`
- 大型本地依赖放在 `packaging/vendor/`,例如 Python runtime、FFmpeg、Playwright、模型、字体、BGM;这些内容默认不入库。
- 构建输出、运行数据和历史整理残留分别由 `.gitignore``archive/` 隔离。
更完整说明见 `docs/PROJECT_LAYOUT.md``packaging/README.md`