update README.md

This commit is contained in:
MaysWind
2025-07-02 23:45:28 +08:00
parent 5400a1424c
commit b60c0b29f8
+75 -39
View File
@@ -6,39 +6,43 @@
[![Latest Release](https://img.shields.io/github/release/mayswind/ezbookkeeping.svg?style=flat)](https://github.com/mayswind/ezbookkeeping/releases) [![Latest Release](https://img.shields.io/github/release/mayswind/ezbookkeeping.svg?style=flat)](https://github.com/mayswind/ezbookkeeping/releases)
## Introduction ## Introduction
ezBookkeeping is a lightweight, self-hosted personal finance app with a user-friendly interface and powerful bookkeeping features. It supports PWA, you can [add the app homepage to the home screen](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/add_to_home_screen.gif) of your mobile device and use it just like a native app. It's easily to be deployed and configured, you can just deploy it by a single command via Docker. It supports almost all platforms, including Windows, macOS, and Linux, and is compatible with x86, amd64 and ARM hardware architectures. It only requires very few system resources, and you can even run it on a Raspberry Pi device. ezBookkeeping is a lightweight, self-hosted personal finance app with a sleek, user-friendly interface and powerful bookkeeping features. Built with simplicity and portability in mind, it's easy to deploy, easy to use, and requires minimal system resources — perfect for microservers, NAS devices, and even Raspberry Pi.
Online Demo: [https://ezbookkeeping-demo.mayswind.net](https://ezbookkeeping-demo.mayswind.net) The app is fully cross-platform and device-friendly — you can use it seamlessly on **mobile, tablet, and desktop devices**. With support for PWA (Progressive Web Apps), you can even [add it to your mobile home screen](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/add_to_home_screen.gif) and use it like a native app.
Live Demo: [https://ezbookkeeping-demo.mayswind.net](https://ezbookkeeping-demo.mayswind.net)
## Features ## Features
1. Open Source & Self-Hosted - **Open Source & Self-Hosted**
2. Lightweight & Fast - Built for privacy and control
3. Easy Installation - **Lightweight & Fast**
* Support Docker - Optimized for performance, runs smoothly even on low-resource environments
* Support multiple databases (SQLite, MySQL, PostgreSQL, etc.) - **Easy Installation**
* Support multiple operation system & hardware architectures (Windows, macOS, Linux & x86, amd64, ARM) - Docker-ready
4. User-Friendly Interface - Supports SQLite, MySQL, PostgreSQL
* Native UI for both desktop and mobile devices - Cross-platform (Windows, macOS, Linux)
* Support PWA, providing near-native experience for mobile devices - Works on x86, amd64, ARM architectures
* Dark theme - **User-Friendly Interface**
5. Powerful Bookkeeping Features - UI optimized for both mobile and desktop
* Support two-level account - PWA support for native-like mobile experience
* Support two-level transaction categories and predefined categories - Dark mode
* Support transaction pictures - **Powerful Bookkeeping**
* Support geographic location tracking and map - Two-level accounts and categories
* Support recurring transactions - Attach images to transactions
* Search and filter transaction records - Location tracking with maps
* Data visualization and statistical analysis - Recurring transactions
6. Localization Support - Advanced filtering, search, visualization, and analysis
* Multi-language support - **Localization & Globalization**
* Multi-currency support with automatic exchange rate updates from various financial institutions - Multi-language and multi-currency support
* Multi-timezone support - Automatic exchange rates
* Customizable date, time, number and currency display formats - Multi-timezone awareness
7. Security & Reliability - Custom formats for dates, numbers, and currencies
* Two-factor authentication (2FA) - **Security**
* Login rate limiting - Two-factor authentication (2FA)
* Application lock (PIN code / WebAuthn) - Login rate limiting
8. Data Export & Import (CSV, OFX, QFX, QIF, IIF, Camt.053, MT940, GnuCash, FireFly III, Beancount, etc.) - Application lock (PIN code / WebAuthn)
- **Data Import/Export**
- Supports CSV, OFX, QFX, QIF, IIF, Camt.053, MT940, GnuCash, Firefly III, Beancount, and more
## Screenshots ## Screenshots
### Desktop Version ### Desktop Version
@@ -48,19 +52,19 @@ Online Demo: [https://ezbookkeeping-demo.mayswind.net](https://ezbookkeeping-dem
[![ezBookkeeping](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/en.png)](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/en.png) [![ezBookkeeping](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/en.png)](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/en.png)
## Installation ## Installation
### Ship with docker ### Run with Docker
Visit [Docker Hub](https://hub.docker.com/r/mayswind/ezbookkeeping) to see all images and tags. Visit [Docker Hub](https://hub.docker.com/r/mayswind/ezbookkeeping) to see all images and tags.
Latest Release: **Latest Release:**
$ docker run -p8080:8080 mayswind/ezbookkeeping $ docker run -p8080:8080 mayswind/ezbookkeeping
Latest Daily Build: **Latest Daily Build:**
$ docker run -p8080:8080 mayswind/ezbookkeeping:latest-snapshot $ docker run -p8080:8080 mayswind/ezbookkeeping:latest-snapshot
### Install from binary ### Install from Binary
Latest release: [https://github.com/mayswind/ezbookkeeping/releases](https://github.com/mayswind/ezbookkeeping/releases) Download the latest release: [https://github.com/mayswind/ezbookkeeping/releases](https://github.com/mayswind/ezbookkeeping/releases)
**Linux / macOS** **Linux / macOS**
@@ -70,9 +74,9 @@ Latest release: [https://github.com/mayswind/ezbookkeeping/releases](https://git
> .\ezbookkeeping.exe server run > .\ezbookkeeping.exe server run
ezBookkeeping will listen at port 8080 as default. Then you can visit `http://{YOUR_HOST_ADDRESS}:8080/` . By default, ezBookkeeping listens on port 8080. You can then visit `http://{YOUR_HOST_ADDRESS}:8080/` .
### Build from source ### Build from Source
Make sure you have [Golang](https://golang.org/), [GCC](http://gcc.gnu.org/), [Node.js](https://nodejs.org/) and [NPM](https://www.npmjs.com/) installed. Then download the source code, and follow these steps: Make sure you have [Golang](https://golang.org/), [GCC](http://gcc.gnu.org/), [Node.js](https://nodejs.org/) and [NPM](https://www.npmjs.com/) installed. Then download the source code, and follow these steps:
**Linux / macOS** **Linux / macOS**
@@ -87,13 +91,45 @@ All the files will be packaged in `ezbookkeeping.tar.gz`.
All the files will be packaged in `ezbookkeeping.zip`. All the files will be packaged in `ezbookkeeping.zip`.
You can also build docker image, make sure you have [docker](https://www.docker.com/) installed, then follow these steps: You can also build a Docker image. Make sure you have [Docker](https://www.docker.com/) installed, then follow these steps:
**Linux** **Linux**
$ ./build.sh docker $ ./build.sh docker
## Documents ## Contributing
We welcome contributions of all kinds!
Found a bug? [Submit an issue](https://github.com/mayswind/ezbookkeeping/issues)
Want to contribute code? Feel free to fork and send a pull request.
Contributions of all kinds — bug reports, feature suggestions, documentation improvements, or code — are highly appreciated.
Check out our [Contributor Graph](https://github.com/mayswind/ezbookkeeping/graphs/contributors) to see the amazing people whove already helped.
## Translating
Help make ezBookkeeping accessible to users around the world! If you want to contribute a translation, please refer to our [translation guide](https://ezbookkeeping.mayswind.net/translating).
Currently available translations:
| Tag | Language | Translator |
| --- | --- | --- |
| de | Deutsch | [@chrgm](https://github.com/chrgm) |
| en | English | / |
| es | Español | [@Miguelonlonlon](https://github.com/Miguelonlonlon) |
| it | Italiano | [@waron97](https://github.com/waron97) |
| ja | 日本語 | [@tkymmm](https://github.com/tkymmm) |
| pt-BR | Português (Brasil) | [@thecodergus](https://github.com/thecodergus) |
| ru | Русский | [@artegoser](https://github.com/artegoser) |
| uk | Українська | [@nktlitvinenko](https://github.com/nktlitvinenko) |
| vi | Tiếng Việt | [@f97](https://github.com/f97) |
| zh_Hans | 中文 (简体) | / |
| zh_Hant | 中文 (繁體) | / |
Don't see your language? Help us add it!
## Documentation
1. [English](http://ezbookkeeping.mayswind.net) 1. [English](http://ezbookkeeping.mayswind.net)
1. [中文 (简体)](http://ezbookkeeping.mayswind.net/zh_Hans) 1. [中文 (简体)](http://ezbookkeeping.mayswind.net/zh_Hans)