Skip to content
xiaoxuraPublic

About

Bookloom(书织)是一个本地优先的跨平台电子书工作台:导入 TXT / EPUB / DOCX,自动识别编码与分章,校对、改元数据、做封面,导出 EPUB 3 / EPUB 2 / DOCX / HTML / TXT / Markdown。Flutter + Dart,Linux / Windows / Android 通用,全程离线,无需账号、不上传书稿,AGPL-3.0 开源。

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

Bookloom / 书织

本地优先的跨平台电子书工作台:导入 TXT / EPUB / DOCX,校对章节、整理元数据、生成封面,导出 EPUB 3 / EPUB 2 / DOCX / 单文件 HTML / TXT / Markdown。

  • 不做账号,不上传文件:所有解析、编辑、导出都在本机完成。
  • Linux / Windows / Android 优先,架构上保留 macOS / iOS 的扩展位。
  • 一套 Flutter UI + 一套 Dart 核心,桌面和移动端共享业务逻辑。
  • 项目代号 Bookloom,中文名 书织。

当前状态:原生工作台核心与本机回归已通过,三端原生实测尚未齐全。三种输入、原生编辑校对、成书、六种输出、批量与备份已有实现和分层测试;平台实测、性能和外部兼容结果以本轮实施记录为准。尚未完成三端发布验收。

书架 · 浅色

快速开始

要求 Flutter stable(当前验证版本 3.47.9 / Dart 3.13.7)与平台构建依赖。

Linux:

sudo apt install clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev

Windows:安装 Visual Studio 2022 Build Tools 的「使用 C++ 的桌面开发」工作负载(含 Windows SDK),并开启开发者模式后重新登录——Flutter 需要它来建插件符号链接。

flutter pub get
dart run build_runner build          # 生成 Drift 代码
flutter gen-l10n                     # 生成多语言代码(首次或改 arb 后)

flutter run -d linux                 # 或 windows / android
flutter analyze
flutter test

打包:

flutter build linux --release
flutter build windows --release
flutter build apk --release --split-per-abi

目录

lib/
  main.dart                # 启动:bootstrap → ProviderScope → App
  app/                     # 启动、路由、全局 provider、壳层、错误处理
    bootstrap.dart         # 路径、日志、数据库、外观偏好
    router.dart            # go_router + StatefulShellRoute
    shell/app_shell.dart   # 玻璃侧栏 / 底部导航
    providers.dart         # 数据库、设置、外观控制器
  core/                    # 纯 Dart:模型、存储、路径、日志、错误、字数
    model/                 # Book / Chapter / Block / Meta / CoverOptions
    storage/               # Drift 表、数据库、settings store
    platform/              # 应用目录等平台能力
  design/                  # 设计系统:tokens / theme / components
    tokens/                # 颜色、字体、间距、圆角、动效、玻璃
    theme/                 # AppTheme + ThemeExtension
    components/            # GlassSurface / AppPage / EmptyState / BookPlate
  features/
    library/               # 书架
    import/                # 导入
    settings/              # 设置
    design_system/         # 设计系统预览页(/design)
  l10n/                    # arb + 生成代码(zh 为模板)
test/                      # 模型、字数、数据库、主题、壳层 widget 测试
docs/                      # 产品、架构、技术栈、数据、路线图、发布、开发、设计系统

关键决策

  • 客户端框架:Flutter(Linux / Windows / Android 一致,后续可扩展 Apple)。
  • 语言:Dart 3;重计算/格式处理优先纯 Dart,必要时通过 FFI 接 Rust/C++。
  • 本地存储:SQLite + Drift;原始文件、图片、封面存应用数据目录,数据库只存引用。
  • 内容模型:Chapter → Block,文字编辑已接入,图片等块保留扩展位;本轮不保留 EPUB 插图及 DOCX 图片、表格、脚注,导入时给出丢失提示。
  • 视觉语言:纸面 + 墨色 + 玻璃浮层,见 设计系统。
  • 应用 ID:com.xiaoxura.bookloom。
  • 官网/文档:https://bookloom.xiaoxura.com;https://bl.xiaoxura.com 作为短链跳转。
  • 许可证:代码采用 AGPL-3.0(见 LICENSE);第三方词典、字体、库单独列 NOTICE。

文档

文档 内容
产品定义 定位、用户、范围、非目标、成功标准
架构设计 分层、模块、平台适配、Isolate、数据流
技术栈 Flutter / Dart 选型、依赖、技术验证清单
数据模型 SQLite 表、内容块模型、备份格式、迁移
路线图 M0–M5、验收标准、风险、第一轮任务
平台与发布 应用 ID、域名、打包、签名、发布流程
开发指南 环境、脚手架、规范、测试、CI、移植说明
设计系统 色彩、字体、间距、玻璃策略、组件约定、截图
下一轮开发计划 Web 能力整合、原生优化、数据契约、实施批次与验收

开发约定

  • 提交使用 Conventional Commits:feat(import): …、fix(export): …、docs: …。
  • main 保持可构建;新功能走 feat/xxx 分支。
  • 界面文案全部走 l10n;颜色、间距、字号全部走设计 token。
  • 业务错误统一用 AppFailure,日志不写正文。

许可证

代码以 AGPL-3.0 发布,见 LICENSE。

  • 自用、修改、分发都可以,前提是保留版权声明;
  • 如果你把修改后的版本部署成网络服务,也需要向用户提供对应源码;
  • 第三方依赖(Flutter、Drift、Riverpod、go_router、window_manager 等)保持各自许可证,汇总在 THIRD_PARTY_NOTICES.md(待补)。

About

Bookloom(书织)是一个本地优先的跨平台电子书工作台:导入 TXT / EPUB / DOCX,自动识别编码与分章,校对、改元数据、做封面,导出 EPUB 3 / EPUB 2 / DOCX / HTML / TXT / Markdown。Flutter + Dart,Linux / Windows / Android 通用,全程离线,无需账号、不上传书稿,AGPL-3.0 开源。

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages