feat: 初始化船长·HeiXiu 桌面应用项目(错误是svg的问题)

Electron + React 19 + TypeScript + Ant Design 6 + Tailwind CSS 4

  【核心架构】
  - Electron 主进程(窗口管理、平台检测、图标适配)
  - Vite 构建链(双产物 dist/ + dist-electron/)
  - 共享层 shared/(类型、常量、工具函数)
  - IPC 通信框架 + 安全守卫

  【主题系统】
  - 蓝紫渐变主题(亮色/暗色双模式)
  - Ant Design ConfigProvider 适配(lightAlgorithm / darkAlgorithm)
  - Tailwind CSS 4 @theme 指令 + CSS 变量
  - 设计令牌三处同步(tokens.ts / globals.css / antd-theme.ts)

  【导航栏】
  - 自定义 H5 导航栏替代系统菜单
  - 个人版/企业版双布局
  - 未登录拦截 + 事件总线驱动登录弹窗

  【登录注册】
  - Modal 弹层(Portal)+ Tabs 切换
  - 登录/注册表单动态字段渲染
  - 记住密码 / 自动登录 / 用户协议

  【更新系统】
  - 自定义 API 版本检查(替代 electron-updater generic provider)
  - 手动下载 + SHA512 校验 + spawn NSIS 安装
  - 渲染进程更新状态机 Hook(useUpdater)
  - 检查更新按钮 + 下载进度展示

  【构建工具链】
  - build.mjs 构建总管(--win/--mac/--linux --personal/--enterprise --build/--clean/--sign/--upload/--publish)
  - scripts/ 自动化脚本(clean / generate-update-info / upload-oss / publish-release)
  - electron-builder NSIS 安装器(可选路径、多版本打包)
  - update-info.json 自动生成(fileSize/sha512/changelog/releaseDate)

  【代码质量】
  - ESLint + TypeScript strict + Prettier
  - husky + lint-staged(提交前自动检查)
  - commitlint(规范提交信息)
  - Playwright E2E + Vitest 单元测试框架
  - rollup-plugin-visualizer 打包体积分析

  【文档】
  - README.md(快速开始 + 目录结构 + 命令速查)
  - UpdateA.md(发布手册:API/签名/发版流程/数据库)
  - CHANGELOG.md(更新日志)
  - .env.example(构建环境变量模板)
This commit is contained in:
2026-06-03 15:00:51 +08:00
commit 767bb8b297
95 changed files with 20814 additions and 0 deletions

162
README.md Normal file
View File

@@ -0,0 +1,162 @@
# 船长·HeiXiu
> 桌面效率工作台 — Electron + React 19 + TypeScript + Ant Design + Tailwind CSS
---
## 技术栈
| 层 | 技术 |
| ---- | ------------------------------ |
| 框架 | Electron 42 |
| 前端 | React 19 + TypeScript + Vite 8 |
| UI | Ant Design 6 + Tailwind CSS 4 |
| 主题 | 蓝紫渐变(亮色 / 暗色) |
| 更新 | 自定义 API + 阿里云 OSS |
| 打包 | electron-builder + NSIS |
---
## 快速开始
```bash
# 安装依赖
npm install
# 开发模式Electron + HMR
npm run dev
# 打包Windows 个人版)
npm run build:win
```
---
## 构建命令
### 打包
```bash
npm run build:win # Windows 个人版
npm run build:win:enterprise # Windows 企业版
npm run build:mac # macOS 个人版
npm run build:linux # Linux 个人版
```
### 构建总管 `build.mjs`
所有打包命令最终调用 `build.mjs`,支持灵活组合操作:
```bash
# 查看帮助
node build.mjs --help
# 仅打包
node build.mjs --win --personal
# 打包 + 上传 OSS + 发布到 API
node build.mjs --win --personal --upload --publish
# 全流程(清理 → 构建 → 签名 → 上传 → 发布)
node build.mjs --win --enterprise --all
# 带签名打包
node build.mjs --win --personal --sign --cert ./cert.pfx --cert-password xxx
# 先清理再构建
node build.mjs --win --personal --clean --build
```
| 操作 | 说明 |
| ----------- | -------------------------------------------------------------- |
| `--build` | 构建默认tsc + vite + electron-builder + update-info.json |
| `--clean` | 构建前清理 release/ dist/ dist-electron/ |
| `--sign` | 代码签名(需配合 `--cert``CSC_LINK` 环境变量) |
| `--upload` | 上传安装包到 OSS |
| `--publish` | POST 版本信息到后端 API |
| `--all` | 全流程 |
### 工具命令
```bash
npm run build:clean # 清理所有构建产物
node scripts/upload-oss.mjs win32 personal 0.1.0 # 手动上传 OSS
node scripts/publish-release.mjs win32 personal 0.1.0 # 手动发布到 API
node scripts/generate-update-info.mjs win32 personal 0.1.0 # 重新生成 info
```
---
## 目录结构
```
ele-heixiu/
├ build.mjs # 构建总管
├ CHANGELOG.md # 更新日志
├ UpdateA.md # 发布手册(后端 API / 签名 / 发版流程)
├ package.json # 项目配置
├ electron-builder.json5 # 打包配置
├ electron/ # Electron 主进程
│ ├ main.ts # 入口
│ ├ preload.ts # 预加载脚本
│ └ main/
│ ├ updater.ts # 自动更新模块
│ ├ menu/ # 菜单
│ └ utils/ # 工具函数
├ src/ # 渲染进程
│ ├ App.tsx # 根组件
│ ├ main.tsx # 渲染入口
│ ├ components/ # 组件
│ │ ├ navbar/ # 自定义导航栏
│ │ └ LegalTextModal.tsx # 协议弹窗
│ ├ pages/
│ │ └ login/ # 登录 / 注册
│ ├ hooks/ # Hooks
│ │ ├ use-theme.tsx # 主题切换
│ │ ├ use-updater.ts # 更新状态
│ │ └ ...
│ ├ theme/ # 主题配置
│ │ ├ tokens.ts # 设计令牌
│ │ ├ globals.css # Tailwind + CSS 变量
│ │ └ adapters/ # Ant Design 适配
│ ├ services/ # API 服务axios
│ ├ utils/ # 工具函数
│ └ assets/ # 静态资源
├ shared/ # 主进程 & 渲染进程共享
│ ├ types/ # 类型定义
│ ├ constants/ # 常量
│ └ utils/ # 通用工具
├ scripts/ # 构建辅助脚本
│ ├ clean.mjs # 清理产物
│ ├ generate-update-info.mjs # 生成 API 信息 JSON
│ ├ upload-oss.mjs # OSS 上传
│ └ publish-release.mjs # 发布到 API
└ release/ # 构建产物
└ {version}/
├ xxx-Setup.exe
└ xxx-update-info.json
```
---
## 环境变量
| 变量 | 默认值 | 用途 |
| ----------------------- | ------------------------------------------------------ | --------------- |
| `UPDATE_API_URL` | `https://www.heixiu.com` | 版本检查 API |
| `UPDATE_API_KEY` | — | 发布 API 鉴权 |
| `UPDATE_DOWNLOAD_BASE` | `https://heixiu.oss-cn-hangzhou.aliyuncs.com/releases` | OSS 下载基地址 |
| `OSS_ENDPOINT` | — | OSS endpoint |
| `OSS_BUCKET` | — | OSS bucket |
| `OSS_ACCESS_KEY_ID` | — | OSS AccessKey |
| `OSS_ACCESS_KEY_SECRET` | — | OSS Secret |
| `CSC_LINK` | — | 签名证书路径 |
| `CSC_KEY_PASSWORD` | — | 签名证书密码 |
| `VITE_API_BASE_URL` | `http://8.160.179.64:8000`dev | 业务 API 基地址 |
---
## 相关文档
- [发布手册](./UpdateA.md) — API 接口、发版流程、签名指南、数据库设计
- [项目架构](./PROJECT.md) — 详细的技术方案与设计决策