hamzamix/loandash

LoanDash - 个人债务与贷款跟踪工具

1. 关于LoanDash

LoanDash是一款现代响应式Web应用，旨在帮助用户轻松管理个人财务。它提供清晰直观的界面，用于跟踪您借入的资金（债务）和借出给他人的资金（贷款）。通过全面的仪表板、详细跟踪和洞察性可视化，LoanDash让您能够掌握财务义务和资产，确保永不遗漏还款日。

该应用基于React、TypeScript和Tailwind CSS构建，提供快速、可靠且视觉吸引力强的用户体验。应用使用Node.js后端将所有数据存储在JSON文件中，并通过Docker卷持久化数据，确保即使容器重启或更新，您的信息也能在服务器上安全保存。

2. 核心功能

• 直观仪表板：快速概览总债务和贷款，通过关键指标和图表获取全面财务快照。
• 详细债务与贷款跟踪：添加、编辑和管理单个债务和贷款，包括金额、到期日、描述和银行贷款的利率等细节。
• 支付记录：轻松记录债务还款和贷款收回情况，进度条直观显示您离还清债务或收回贷款的距离。
• 利息计算：对于银行类型的贷款，应用会自动计算并累计剩余余额的月利息。
• 循环债务：设置每月循环债务（如订阅或定期借款），在还清后自动再生。
• 归档系统：通过归档已完成或违约的项目保持主仪表板整洁，归档记录可查看或永久删除。
• 深色模式：在明暗主题间切换，适应不同光线条件下的舒适查看。
• 响应式设计：全响应式布局确保在桌面、平板和移动设备上的无缝体验。
• 数据导出：将所有债务和贷款数据下载为CSV文件，用于备份或外部分析。
• 智能通知：头部的视觉指示器提醒您逾期项目。
• 搜索功能：快速查找应用中的特定债务、贷款或归档项目。
• 设置面板：自定义应用行为，如设置已还清项目的自动归档规则。
• 持久化数据：所有数据存储在持久化Docker卷中，确保财务记录在容器重启和更新后保持安全。

3. 使用场景

• 个人用户跟踪自身借款（如***欠款、银行贷款）的还款进度和利息情况
• 记录向他人借出的款项，跟踪对方还款状态
• 管理循环性债务（如订阅费用、定期借款）
• 导出财务数据用于外部分析或备份

4. 配置与部署说明

前提条件

开始前，请确保系统已安装以下工具：

• Git：用于克隆仓库
• Docker Desktop（Windows/macOS）或Docker Engine & Docker Compose（Linux）：用于运行容器
  • https://www.docker.com/products/docker-desktop
  • https://docs.docker.com/engine/install/
  • https://docs.docker.com/compose/install/

安装与部署

此方法使用Docker Hub上的预构建镜像，是快速启动的最佳方式。

1. 克隆仓库
   导航到您希望存储项目的位置，运行：

   bash
   git clone https://github.com/hamzamix/LoanDash.git
   cd LoanDash
   

2. 或手动下载
   您也可以仅手动下载https://github.com/hamzamix/LoanDash/blob/main/docker-compose.yml%E6%96%87%E4%BB%B6%E3%80%82

3. 启动应用
   在LoanDash目录（包含docker-compose.yml的位置）中执行：

   bash
   sudo docker-compose up -d
   

   • Docker Compose将自动从Docker Hub拉取hamzamix/loandash:latest镜像（如果本地未存在）
   • 创建并启动loandash容器，将主机的8050端口映射到应用内部的3000端口
   • 创建loandash-data卷（若不存在），确保db.json数据在容器重启和更新后持久化

4. 访问应用
   打开浏览器并导航至：

   http://<您的服务器IP>:8050
   

   您的LoanDash应用现在已运行！

更新应用

当Docker Hub上推送LoanDash新版本时，您可以轻松更新运行实例：

1. 导航到项目目录

   bash
   cd /path/to/your/LoanDash
   

2. 拉取最新镜像并重建容器

   bash
   sudo docker-compose pull loandash # 获取loandash服务的最新镜像
   sudo docker-compose up -d --force-recreate # 停止、删除并重新创建容器（使用新镜像）
   

   此过程确保loandash-data卷保持完整，保留您的db.json数据。

许可证

本项目采用Apache License 2.0许可。详情请查看LICENSE文件。