家庭会计工具(Family Accounting Tool)安装与使用指南

本指南基于GitHub上的开源项目Family Accounting Tool，为您提供详细的安装与配置步骤，确保您能够顺利运行这个家庭财务管理软件。

1. 项目目录结构及介绍

项目根目录主要结构:

• LICENSE: 许可证文件，描述了该项目的使用条款。
• README.md: 项目简介，包括功能概述和快速入门信息。
• bin: 包含可执行脚本，如用于启动服务的server脚本。
• conf: 配置文件夹，存放数据库连接等关键配置。
  • application.conf: 应用核心配置，包括数据库设置、应用密钥等。
  • scalafmt.conf: Scala代码格式化配置。
• docker-compose-for-tests.yml, docker-compose.yml: Docker相关的配置文件，用于容器化部署。
• src: 源代码目录，包含了Scala等源码文件。
• 其他支持文件，如.gitignore, .jshintrc, 以及用于测试的Docker配置和截图等。

重点目录说明:

• conf: 是管理数据库配置、应用秘密和其他环境特定设置的核心部分。
• bin: 提供直接操作应用的服务脚本，简化启动流程。

2. 项目的启动文件介绍

主要启动文件: bin/server

此脚本是服务启动的关键，通过不同的命令行参数可以实现不同的操作：

• Drop and Create New DB: -DdropAndCreateNewDb 在启动前清空并重新创建数据库表。
• Create Admin User: -DcreateAdminUser 创建初始管理员用户。
• Normal Startup: 不带特殊参数直接启动应用。

使用方法示例：

# 清空数据库并新建表
bin/server -DdropAndCreateNewDb

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

# 运行应用
bin/server

注: 在运行应用之前，需要确保已经正确配置了数据库连接和应用的其他必要设置。

3. 项目的配置文件介绍

application.conf

这是项目的主配置文件，涵盖以下几个关键配置部分：

• 数据库设置: 包括驱动、URL、用户名、密码等，例如MariaDB的配置。
• 应用密钥: 如play.http.secret.key，对会话进行加密，需设定一个独特且安全的值。
• 内部默认设置: 如默认密码等，通常在首次部署时需修改以增强安全性。

示例配置片段展示数据库配置部分:

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

play.http.secret.key="your-generated-secret-key"

重要提示: 修改配置后，确保重启应用以使更改生效。

通过以上步骤，您可以成功设置并运行家庭会计工具，它将帮助您追踪家庭的所有交易，提供有用的统计信息，并管理内部债务等财务事务。记得在实际部署前详细阅读项目文档，并根据自身需求调整配置。