ezBookkeeping安装与配置指南

1. 项目基础介绍

ezBookkeeping 是一个轻量级、自托管的个人记账应用程序，拥有对桌面和移动设备友好的用户界面。它支持PWA（渐进式Web应用程序），可以在移动设备上像原生应用一样使用。ezBookkeeping 易于部署和配置，可以通过Docker单一命令进行部署。它支持几乎所有平台，包括 Windows、macOS 和 Linux，并且与 x86、amd64 和 ARM 硬件架构兼容。此外，它的系统资源需求极低，甚至可以在 Raspberry Pi 设备上运行。

本项目主要使用的编程语言是 Go，同时使用了 Vue 和 TypeScript 进行前端开发。

2. 关键技术和框架

• 后端: 使用 Go 语言开发，具有高性能和简洁性。
• 前端: 基于Vue框架和TypeScript语言，实现动态和响应式用户界面。
• 数据库: 支持多种数据库系统，包括 SQLite、MySQL、PostgreSQL 等。
• 容器化: 支持Docker，便于部署和扩展。
• PWA: 支持渐进式Web应用程序特性，提供类原生应用体验。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统满足以下要求：

• Docker: 如果您计划使用Docker进行部署，需要确保Docker在您的系统中已经安装并运行。
• Go: 如果您计划从源代码编译，需要安装Go语言环境。
• Node.js 和 NPM: 用于前端构建。
• GCC: 用于编译Go程序。

安装步骤

使用Docker安装

1. 打开命令行界面。
2. 运行以下命令以启动ezBookkeeping服务：

docker run -p 8080:8080 mayswind/ezbookkeeping

服务启动后，您可以通过浏览器访问 http://localhost:8080 来使用应用。

从二进制文件安装

1. 访问项目的最新发布页面下载对应操作系统的最新版本。
2. 解压下载的文件。
3. 在命令行中运行以下命令启动服务：

• 对于 Linux 或 macOS：

./ezbookkeeping server run

• 对于 Windows：

.\ezbookkeeping.exe server run

服务默认监听8080端口，您可以通过浏览器访问 http://{YOUR_HOST_ADDRESS}:8080 来使用应用。

从源代码编译

1. 克隆项目仓库到本地：

git clone https://github.com/mayswind/ezbookkeeping.git

2. 进入项目目录，根据您的操作系统执行以下命令：

• 对于 Linux 或 macOS：

./build.sh package -o ezbookkeeping.tar.gz

• 对于 Windows：

.\build.bat package -o ezbookkeeping.zip

3. 解压生成的压缩包，并运行启动命令，如上所述。

现在，您应该已经成功安装了ezBookkeeping，并可以通过浏览器访问它来开始使用。