Files
FileHost/docs-site/guide/local-dev.md
T
O96u 58a8e2082f fix: docs Pages deploy permissions and document GitHub Pages setup
Deploy job failed because Pages source must be GitHub Actions; document
About/description guidance and fix workflow job permissions.
2026-08-29 11:53:20 +08:00

2.0 KiB
Raw Blame History

本地开发

在仓库根目录进行 Nuxt 4 全栈开发,数据默认写入 ./data。

环境要求

  • Node.js 22
  • npm 11(与 package.json 中 packageManager 一致)

启动

npm install
cp .env.example .env   # 可选
npm run dev

访问 http://localhost:3000/setup 创建管理员。数据目录默认 ./data(DATA_DIR 可改)。

常用命令

命令 说明
npm run dev 开发服务器
npm run build 生产构建
npm run start 运行 .output
npm run lint ESLint
npm run typecheck 类型检查
npm test 单元测试
npm run reset-password 重置密码(可选用户名)
npm run migrate 预览遗留目录迁移(加 -- --apply 执行)

开发专用环境变量

变量 说明
DEV_BYPASS_ACCESS 设为 true 可绕过登录(跳过 /setup,一般无需开启)
DATA_DIR 数据目录,默认 ./data

完整变量列表见 环境变量。

双域名本地测试

修改系统 hosts 后可用两个测试域名验证分离逻辑,步骤见 双域名分离。

文档站

npm run docs:dev      # VitePress 开发
npm run docs:build    # 构建静态站点
npm run docs:preview  # 预览构建结果

文档源码在 docs-site/;截图源文件在 docs/screenshots/(含 login.png 登录页),构建前会复制到 docs-site/public/screenshots/。

发布到 GitHub Pages

在线文档地址:https://o96u.github.io/PicHost/

首次启用(部署 job 失败、访问 404 时检查):

  1. 仓库 Settings → Pages
  2. Build and deployment → Source 选择 GitHub Actions(不要选 Deploy from a branch)
  3. 推送 main 触发 docs workflow,或在 Actions 页手动 Run workflow

构建成功后约 1–2 分钟可访问。docs workflow 的 deploy 步骤失败且日志提示 Pages 未启用时,多为未完成上述设置。