ezBookkeeping 项目使用教程
1. 项目目录结构及介绍
ezBookkeeping 是一个轻量级、自托管个人记账应用。下面是项目的目录结构及各部分的简要介绍:
ezbookkeeping/
├── cmd/ # 主应用程序的入口和命令行处理代码
├── conf/ # 配置文件模板和配置管理相关代码
├── docker/ # Dockerfile和相关脚本,用于Docker化应用
├── etc/ # 系统服务配置文件,如systemd服务文件
├── pkg/ # 包含业务逻辑和模型代码
├── public/ # 公共静态资源,如CSS、JavaScript和图片
├── src/ # 前端源代码目录
├── templates/ # 邮件模板等
├── testdata/ # 测试数据
├── .editorconfig # 编辑器配置文件
├── .gitignore # Git忽略文件列表
├── Dockerfile # Docker构建文件
├── LICENSE # 项目许可证文件
├── README.md # 项目说明文件
├── build.bat # Windows环境下的构建脚本
├── build.sh # Linux/macOS环境下的构建脚本
└── go.mod # Go语言依赖管理文件
2. 项目的启动文件介绍
项目的启动文件位于 cmd/ezbookkeeping/main.go,这是Go程序的入口点。以下是启动文件的主要部分:
- 初始化配置解析
- 设置日志记录
- 启动HTTP服务
启动文件会调用 cmd/ezbookkeeping/app.go 中的 Run 函数来启动应用。
3. 项目的配置文件介绍
项目的配置文件位于 conf/app.conf。这是一个标准的ini格式配置文件,包含了应用运行所需的各种配置项,例如:
- 数据库连接信息
- 应用服务监听的端口
- 语言和货币设置
- 安全相关的配置,例如JWT密钥和登录尝试限制
配置文件的结构如下:
[database]
driver = sqlite
source = ./data.db
[service]
http_port = 8080
[localization]
default_language = en
default_currency = USD
[security]
jwt_secret = YourJWTSecretKey
max_login_attempts = 5
lockout_time = 15m
在部署应用时,可以根据实际环境修改这些配置项。如果使用Docker部署,可以通过环境变量来覆盖配置文件中的默认值。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



