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
What is this?Actual Budget is a local-first personal finance app built around envelope budgeting. It is 100% free and open-source, written in NodeJS, and syncs your changes between devices.
Is this a desktop app I install, or a server I run somewhere?It is both: downloadable local-only apps for Windows, Mac and Linux, plus a sync server component so the same budget follows you across devices.
How do I get it running?Four ways to deploy: one-click on PikaPods (recommended for non-technical users), managed hosting on Fly.io, self-hosting via the Docker image, or downloading a local desktop app.
Do I need to install anything before using it?Nothing for normal use — the local apps are self-contained, and self-hosting just needs Docker. Contributing to development requires NodeJS 22.18+ with Yarn 4.
What does it cost — is the hosting part paid?The app itself is 100% free and open-source with no subscriptions. Only managed hosting costs money: about $2/month on PikaPods and $1.50/month on Fly.io — Docker self-hosting and the local apps are free.
Where does my financial data actually live?On your own device first — the app is local-first, and the sync element only moves changes between devices, so self-hosting keeps everything on infrastructure you control.
What is envelope budgeting, the method Actual is built around?Actual is designed around the envelope budgeting approach. The README points to a doc explaining the idea behind it, and the community offers a Starting Fresh guide for people new to budgeting.
I use another budgeting app — can I switch and keep my data?Yes — the community maintains a Migration guide specifically for people moving over from other budgeting apps, alongside the Starting Fresh guide if you would rather begin from zero.
Do I need the server if I only use one device?No — the local-only apps run entirely on your device, and the sync server exists to move changes between devices when you use more than one.
What is Actual built with under the hood?NodeJS with a TypeScript frontend. The repo splits into loot-core (the core application that runs on any platform), desktop-client (the desktop UI) and desktop-electron (the desktop app).
Size
640.9 MB
Stars
29.6K
Age
4y
Commits · 90 Days