Family Accounting Tool 使用教程

1. 项目介绍

Family Accounting Tool 是一个家庭记账工具，旨在帮助家庭记录每一笔交易，并从中提取有用的统计数据。该工具的主要功能包括：

• 统计数据提取：例如，每月在食品上的花费。
• 内部债务计算：例如，Alice 为整个家庭购买了卫生纸，工具会记录家庭欠 Alice 的金额。
• 检查意外支出：确保没有资金在意外的地方消失，例如隐藏的银行费用。

2. 项目快速启动

2.1 安装 Java 11

首先，确保你的服务器上已经安装了 Java 11 (JDK 11)。

2.2 下载并解压项目

从项目的最新发布版本中下载“二进制文件（编译文件）与演示配置”，并解压到你的服务器上。

2.3 配置数据库

打开解压后的文件夹中的 conf/application.conf 文件，配置数据库。最简单的方法是在本地设置一个 MariaDB 服务器，并创建一个名为 facto 的空数据库，然后进行如下配置：

db {
  default {
    driver = "com.mysql.jdbc.Driver"
    url = "jdbc:mysql://localhost/facto?user=mysqluser&password=mysqlpassword"
    slick.profile = "slick.jdbc.MySQLProfile$"
  }
}

2.4 运行应用程序

在解压后的文件夹中打开终端，运行以下命令以启动应用程序：

# 创建数据库表
bin/server -DdropAndCreateNewDb

# 创建管理员用户
bin/server -DcreateAdminUser

# 运行应用程序
bin/server

2.5 访问应用程序

在浏览器中访问 http://localhost:9000/app/useradministration，使用用户名 admin 和密码 changeme 登录。

3. 应用案例和最佳实践

3.1 家庭日常记账

Family Accounting Tool 非常适合用于家庭日常记账。通过记录每一笔支出和收入，家庭成员可以清楚地了解每月的财务状况，并及时发现不必要的支出。

3.2 内部债务管理

在家庭中，经常会有成员为其他成员支付费用的情况。通过使用 Family Accounting Tool，可以轻松记录这些内部债务，并在适当的时候进行结算。

3.3 预算管理

通过定期分析工具中的统计数据，家庭可以制定合理的预算，并确保每月的支出在预算范围内。

4. 典型生态项目

4.1 MariaDB

Family Accounting Tool 使用 MariaDB 作为其数据库后端。MariaDB 是一个开源的关系型数据库管理系统，具有高性能和可靠性。

4.2 Docker

虽然官方不推荐使用 Docker 进行生产环境的部署，但 Docker 可以用于快速启动一个演示服务器。通过 Docker Compose，可以轻松地在本地环境中运行 Family Accounting Tool。

# 获取 docker-compose.yml 文件
wget https://raw.githubusercontent.com/nymanjens/facto/master/docker-compose.yml

# 生成一个随机的应用密钥
export APPLICATION_SECRET="$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)"

# 创建数据库并启动服务器
docker-compose run web sleep 5
docker-compose run web bin/server -DdropAndCreateNewDb
docker-compose run web bin/server -DcreateAdminUser
docker-compose up

通过以上步骤，你可以在本地环境中快速启动 Family Accounting Tool，并开始使用它来管理家庭财务。