mirror of https://github.com/Awuqing/BackupX.git synced 2026-05-11 18:10:23 +08:00

Files

Wu Qing a6dd8033ed 文档: 新增 Docusaurus 官网与双语文档，README 切换为英文默认 (#39 )

- 新建 docs-site/ Docusaurus 项目，支持 en + zh-Hans 双语
- 从 README 迁移内容为独立文档页面：
  - Getting Started（安装、快速开始）
  - Deployment（Docker、裸机、Nginx、配置参考）
  - Features（备份类型、存储后端、SAP HANA、多节点集群、通知）
  - Reference（API、CLI）
  - Development（开发、贡献）
- 自定义 BackupX 主题色、logo、落地页组件
- 新增 .github/workflows/docs.yml，Actions 自动构建并发布到 GitHub Pages
- README.md 切换为英文，中文版挪到 README.zh-CN.md，两者均精简为导航型
- 配置站点 URL：https://awuqing.github.io/BackupX/

2026-04-17 13:19:41 +08:00

2.3 KiB

Raw Blame History

sidebar_position, title, description

sidebar_position	title	description
1	开发环境	搭建 BackupX 本地开发环境 — 后端、前端、测试。

开发环境

环境要求： Go ≥ 1.25，Node.js ≥ 20，npm。

克隆与依赖

git clone https://github.com/Awuqing/BackupX.git && cd BackupX
cd web && npm install && cd ..

开发服务

开两个终端分别跑后端和前端：

# 终端 1：后端，监听 :8340
make dev-server

# 终端 2：Vite HMR，监听 :5173
make dev-web

Vite 配置了 /api 代理到 http://127.0.0.1:8340，浏览器直接访问 http://localhost:5173。

测试

make test           # 运行 Go + Web 全部测试
make test-server    # 仅 Go
make test-web       # 仅 Vitest

生产构建

make build          # server/bin/backupx + web/dist
make docker         # Docker 镜像
make docker-cn      # 国内镜像加速构建

技术栈

组件	技术
后端	Go · Gin · GORM · SQLite · robfig/cron · rclone
前端	React 18 · TypeScript · ArcoDesign · Vite · Zustand · ECharts
存储	rclone（70+ 后端）· AWS SDK v2 · Google Drive API v3
安全	JWT · bcrypt · AES-256-GCM

目录结构

BackupX/
├── server/             # Go 后端
│   ├── cmd/backupx/    # 入口 + 子命令（agent / backint / reset-password）
│   ├── internal/
│   │   ├── agent/      # Agent CLI 逻辑
│   │   ├── app/        # 装配（repo → service → handler）
│   │   ├── backup/     # 备份 runner（file / mysql / postgres / sqlite / saphana）
│   │   ├── backint/    # SAP HANA Backint 协议
│   │   ├── http/       # HTTP handler + router
│   │   ├── model/      # GORM 模型
│   │   ├── repository/ # 数据访问
│   │   ├── service/    # 业务逻辑
│   │   └── storage/    # 存储 provider（rclone + 直接 SDK）
│   └── pkg/            # 通用工具
├── web/                # React 前端（Vite）
│   └── src/
│       ├── components/
│       ├── pages/
│       ├── services/
│       └── types/
├── docs-site/          # 文档站（Docusaurus）
├── deploy/             # install.sh / systemd unit / nginx config
└── Makefile

2.3 KiB Raw Blame History Unescape Escape