actual README

The project's README from github.com/actualbudget/actual. As one markdown file: README.md.

Actualbudget

Getting Started

Actual is a local-first personal finance tool. It is 100% free and open-source, written in NodeJS, it has a synchronization element so that all your changes can move between devices without any heavy lifting.

If you are interested in contributing, or want to know how development works, see our contributing document we would love to have you.

Want to say thanks? Click the ⭐ at the top of the page.

Installation

There are four ways to deploy Actual:

  1. One-click deployment via PikaPods (~2.00 $/month) - recommended for non-technical users
  2. Managed hosting via Fly.io (~1.50 $/month)
  3. Self-hosted by using a Docker image
  4. Local-only apps - downloadable Windows, Mac and Linux apps you can run on your device

Learn more in the installation instructions docs.

Ready to Start Budgeting?

Read about Envelope budgeting to know more about the idea behind Actual Budget.

Are you new to budgeting or want to start fresh?

Check out the community's Starting Fresh guide so you can quickly get up and running!

Are you migrating from other budgeting apps?

Check out the community's Migration guide to start jumping on the Actual Budget train!

Documentation

We have a wide range of documentation on how to use Actual, this is all available in our Community Documentation, this includes topics on Budgeting, Account Management, Tips & Tricks and some documentation for developers.

Contributing

Actual is a community driven product. Learn more about contributing to Actual.

Code structure

The Actual app is split up into a few packages:

More information on the project structure is available in our community documentation.

Feature Requests

Current feature requests can be seen here. Vote for your favorite requests by reacting :+1: to the top comment of the request.

To add new feature requests, open a new Issue of the "Feature Request" type.

Translation

Make Actual Budget accessible to more people by helping with the Internationalization of Actual. We are using a crowd sourcing tool to manage the translations, see our Weblate Project. Weblate proudly supports open-source software projects through their Libre plan.

Translation status

Repo Activity

Alt

Sponsors

Thanks to our wonderful sponsors who make Actual Budget possible!

Deploys by Netlify Built with Depot Docker GitHub Anthropic

actual (actualbudget/actual)

Searching Database…

29.6K ·GitHub
Actual
这是什么？Actual Budget 是一款以本地优先为原则的个人记账应用，围绕信封预算法设计。它 100% 免费且开源，用 NodeJS 编写，并能在你的多台设备之间同步修改。
它是我安装的桌面应用，还是部署在某处的服务器？两者都是：既提供可下载的纯本地应用，支持 Windows、Mac 和 Linux，也有同步服务器组件，让同一份预算在多台设备之间保持一致。
我该怎么把它跑起来？有四种部署方式：在 PikaPods 上一键部署（推荐给非技术用户）、使用 Fly.io 托管服务、通过 Docker 镜像自行托管，或下载本地桌面应用。
使用之前需要安装什么吗？日常使用什么都不需要——本地应用开箱即用，自行托管也只需要 Docker。如果要参与开发，则需要 NodeJS 22.18+ 和 Yarn 4。
要花多少钱——托管部分是收费的吗？应用本身 100% 免费开源，没有任何订阅费用。只有托管服务要花钱：PikaPods 大约每月 2 美元，Fly.io 大约每月 1.50 美元——Docker 自托管和本地应用都是免费的。
我的财务数据到底存在哪里？首先存在你自己的设备上——这款应用是本地优先的，同步功能只在设备之间传送改动，因此自行托管可以把所有数据都保留在你掌控的基础设施上。
Actual 所采用的信封预算法是什么？Actual 的设计围绕信封预算法展开。README 里链接了一份讲解其理念的文档，社区还为预算新手提供了 Starting Fresh 指南。
我用的是别的记账应用，可以换过来并保留我的数据吗？可以——社区专门为从其他记账应用迁移过来的用户维护了一份 Migration 指南；如果你更想从零开始，也可以参考 Starting Fresh 指南。
如果我只用一台设备，还需要服务器吗？不需要——纯本地应用完全在你的设备上运行，同步服务器只是为了在多台设备之间同步改动而存在的。
Actual 底层是用什么构建的？NodeJS 加上 TypeScript 前端。代码仓库分为 loot-core（可在任何平台运行的核心应用）、desktop-client（桌面界面）和 desktop-electron（桌面应用）。
What are similar projects?aurelio-finance, Aurum, firefly-iii, sure, trade-journal, bankmcp, Termix, spacedrive
Which topics is it in?money, budgeting, personal-finance, sync, self-hosting, finance, electron, local-first, desktop, gui, privacy, server
Creator
actualbudget
Size
642.3 MB
Stars
29.6K
Updated
CommitOct 17Releasev26.10.0Oct 02
Age
4y
Commits · 90 Days