mirror of
https://github.com/KingHWJ/WeReadBoard.git
synced 2026-11-03 18:24:58 +08:00
docs: 补充 v2 接口文档与验证截图,更新 README
- docs/V2_API.md 说明 /api/v2/* 各接口参数与回包结构 - docs/screenshots/ 归档概览/书架/笔记/详情/发现/暗色主题验证截图 - README 说明 v2 为默认前端、启动方式与 v1 归档位置
This commit is contained in:
1 parent
4cbaabd42c
commit
d917936049
9 files changed
+66
-7
No files matched your search
@@ -1,20 +1,29 @@
|
||||
# 微信读书数据展示网站
|
||||
|
||||
基于微信读书 API 的个人读书数据展示网站,数据存储在本地 SQLite 数据库中。
|
||||
基于微信读书 API 的个人读书数据展示网站。
|
||||
|
||||
- **v2「阅间」看板(当前默认前端)**:沿用设计稿的视觉与交互,数据来自 `/api/v2/*` 实时聚合接口,见 `docs/V2_API.md`。
|
||||
- **v1 仪表盘(已归档)**:原 ECharts 单页仪表盘,完整备份在 `legacy/v1/`。
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
.
|
||||
├── fetch_data.py # 数据采集脚本(从微信读书 API 拉取数据到 SQLite)
|
||||
├── app.py # Flask 后端服务
|
||||
├── app.py # Flask 后端服务(v1 接口 + 注册 v2 Blueprint)
|
||||
├── api_v2.py # v2 数据接口层(/api/v2/*,供「阅间」前端使用)
|
||||
├── start_dashboard.sh # 启动脚本(端口可用 PORT 覆盖)
|
||||
├── legacy/v1/ # v1 前端备份(index.html / style.css / app.js)
|
||||
├── weread.db # SQLite 数据库(运行 fetch_data.py 后生成)
|
||||
├── requirements.txt # Python 依赖
|
||||
├── templates/
|
||||
│ └── index.html # 前端页面
|
||||
│ └── index.html # 「阅间」前端页面(v2 设计稿)
|
||||
└── static/
|
||||
├── css/style.css # 样式文件
|
||||
└── js/app.js # 前端逻辑
|
||||
├── css/styles.css # v2 样式(设计稿原样)
|
||||
├── css/style.css # v1 样式(保留)
|
||||
└── js/
|
||||
├── weapi.js # v2 数据层(封装 /api/v2/*)
|
||||
└── app.js # v2 交互逻辑
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
@@ -42,10 +51,15 @@ python fetch_data.py
|
||||
### 4. 启动网站
|
||||
|
||||
```bash
|
||||
python app.py
|
||||
./start_dashboard.sh # 默认 8770 端口
|
||||
PORT=8080 ./start_dashboard.sh # 或指定端口
|
||||
```
|
||||
|
||||
访问 http://127.0.0.1:8080 即可查看读书数据展示。
|
||||
也可以直接 `python app.py`(默认 8080,可用环境变量 `PORT` 覆盖),
|
||||
然后访问 http://127.0.0.1:8770 查看「阅间」看板。
|
||||
|
||||
> v2 的书架、统计、推荐、搜索等数据实时来自微信读书接口;
|
||||
> 未运行 `fetch_data.py` 时也能使用,只有进度/笔记等局部数据会缺少缓存加速。
|
||||
|
||||
## 功能模块
|
||||
|
||||
|
||||
Reference in new issue
Block a user