Files
2026-11-16 20:45:22 +08:00

105 lines
3.1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Sakura Downloader(樱云下载器)
个人媒体采集、本地图库管理与跨设备云同步系统。
| 端 | 角色 |
|----|------|
| Windows 桌面端 | 采集与整理中枢 |
| Sakura Cloud | 数据与账号中心 |
| Android 客户端 | 跨设备阅读与提醒 |
## 成品文件(`releases/`)
| 文件 | 说明 | 大小(约) |
|------|------|------------|
| `releases/sakuradownloader.exe` | Windows 桌面端,双击即用 | ~68 MB |
| `releases/app-release.apk` | Android 客户端(调试签名,适合自测) | ~54 MB |
构建产物来源:
- EXE:`dist/sakuradownloader.exe` → 复制到 `releases/`
- APK:`sakura_mobile/build/app/outputs/flutter-apk/app-release.apk` → 复制到 `releases/`
## 文档索引
| 文档 | 面向读者 | 内容 |
|------|----------|------|
| [使用说明-桌面版与安卓版.md](使用说明-桌面版与安卓版.md) | 终端用户 | 登录、下载、云同步、手机端操作 |
| [docs/项目功能交付书.md](docs/项目功能交付书.md) | 产品 / 验收 | 功能模块、架构、API、代码索引 |
| [docs/项目文档.md](docs/项目文档.md) | 开发者 | 环境、目录、构建、部署、开发流程 |
| [项目文件/BUILD.md](项目文件/BUILD.md) | 开发者 | EXE / APK 打包细节与排错 |
## 快速开始(源码)
### 桌面端
```powershell
python -m venv .venv
.\.venv\Scripts\activate
pip install -r requirements.txt
python main.py
```
### 云端(可选)
```powershell
pip install -r sakura_cloud/requirements.txt
uvicorn sakura_cloud.main:app --reload
```
### 移动端(开发)
```powershell
cd sakura_mobile
flutter pub get
flutter run
```
## 一键打包
```powershell
# 桌面 EXE
scripts\build_desktop_exe.bat
# Android APK(需 JDK 17+,仓库内 tools\flutter 与 tools\android-sdk)
scripts\build_mobile_android.bat
# 打包后复制到 releases/
scripts\copy_release_artifacts.bat
# 或依次执行 EXE + APK + 复制
scripts\build_all.bat
```
## 技术栈摘要
- 桌面:Python 3.8+、CustomTkinter、SQLite、Playwright(X 插件)
- 云端:FastAPI、PostgreSQL、JWT
- 移动:Flutter、Riverpod、Dio
## 目录结构(精简)
```text
Pixiv/
├── main.py # 桌面入口
├── pixiv_app/ # 桌面核心(GUI、下载、图库、云同步)
├── plugins/ # Pixiv / X 等插件
├── sakura_cloud/ # 云端 API、docker-compose、Alembic
├── sakura_mobile/ # Flutter 安卓端
├── releases/ # 可分发成品(EXE / APK)
├── docs/ # 交付书、开发文档
├── scripts/ # 构建与依赖安装脚本
├── tools/ # 辅助脚本(如代码统计)
└── 项目文件/ # 迭代与专题说明
```
## 许可与说明
- APK 当前为 **调试签名**,仅供个人测试,不宜直接上架分发。
- 使用 X 插件前需安装 Playwright Chromium(见 `项目文件/BUILD.md`)。
- 会话与图库数据默认保存在 `%LOCALAPPDATA%\PixivDownloader`(打包版)。
---
*最后构建:2026-06-05*