Files
ledgerly-docs/guide/getting-started.md
T
rosercode 923d6db5c0 docs: 同步汇账最新功能,新增智能查数、账单关系等文档
对照 ledgerly 自文档上次更新以来的全部改动,补充新功能文档、修正品牌与版本残留,并新增下载与安装页;配图已重新截取并上传 OSS,本地截图目录不纳入版本管理。

变更内容:
- 新增「智能查数」「账单关系」两个使用文档页,并登记侧边栏与总览
- 设置页扩充为八个面板(账号安全、数据库实时进度、外观、导航等)并改为即时保存
- 收支记录补充关系列、批量操作、AI 搜索浮窗、可配置分页与「账单详情」弹窗
- 统计面板补充饼图/渠道图下钻与筛选双向联动;规则管理补充批量删除
- AI 能力补充智能查数与关系命名;新增下载与安装页
- 开发文档同步:AI 13 类调用、数据模型 24 张表、API、前端偏好、构建部署
- 统一「汇账 Ledgerly」品牌与「设置/日志」菜单文案,版本号对齐 0.1
- 截图脚本新增账单详情等场景并更新登记

说明:
- download.md 的 OSS 下载链接保持待发布产物回填,暂不调整
- 已通过 npm run docs:build 与 npm run typecheck:scripts
2026-09-26 21:57:38 +08:00

3.1 KiB
Raw Blame History

快速开始

本章面向已部署好的系统,介绍初次使用时需要完成的配置与操作。

如何安装、启动与部署(开发模式、打包可执行 jar、Docker),请见开发文档的构建与部署。

访问系统

使用部署者提供的地址访问,例如:

  • 本机部署:http://localhost:8080(端口以实际部署为准)
  • 局域网 / 服务器:http://<服务器 IP>:<端口>

在线体验

不想自行部署?可直接访问在线演示环境:

在线环境使用独立的 SQLite 演示库与虚构数据,仅供功能体验,请勿录入真实账目。

首次访问且数据库尚未配置时,会自动进入「初始化数据库」引导页。

数据库配置

系统支持在服务启动之后再配置数据库,无需启动前准备:

  • 未检测到配置时,应用仍可正常启动,前端会引导进入「初始化数据库」页面。
  • 支持 SQLite(本地单文件,零配置)与 MySQL 两种数据库。
  • 保存配置后立即生效并自动建表,无需手动执行 SQL。
  • 配置持久化在 config/database.json,SQLite 数据默认位于 data/ 目录。

数据库初始化

首次进入时按引导选择数据库类型并填写连接信息,点击「保存并应用」即可。登录后可通过右上角用户菜单 →「设置」→「数据库配置」随时切换数据库;切换后原数据库的数据保留,不做自动迁移。

注册与登录

  • 首次使用需要注册账号。若系统尚无任何用户,注册入口始终可用。
  • 注册成功后使用用户名与密码登录,登录状态通过 JWT 保存。

登录卡片

注册卡片

注册功能可在「设置 → 注册设置」中开启或关闭。新注册用户会自动获得一套默认分类、标签与邮箱发件人规则。

界面语言

系统支持简体中文、English、日本語三种语言。登录页、注册页右上角以及主界面顶部栏均可切换语言。

首次使用建议

  1. 完成数据库配置并注册登录。
  2. 进入「分类管理」「标签管理」按自己的习惯调整分类与标签。
  3. 在「规则管理」配置常用自动归类规则(如「星巴克 → 餐饮」)。
  4. 导出并导入历史账单(见账单类型与获取)。
  5. 在「设置」中按需配置「AI 模型」「定时通知」「邮箱账单」,并可调整「外观设置」与「导航设置」。
  6. 启用 AI 后,可用左侧「智能查数」以自然语言查询账本。

下一步