mirror of
https://github.com/actualbudget/actual.git
synced 2026-03-09 06:02:22 -05:00
84 lines
3.9 KiB
Markdown
84 lines
3.9 KiB
Markdown
<p align="center">
|
|
<img src="/demo.png" alt="Actualbudget" />
|
|
</p>
|
|
|
|
## 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](https://actualbudget.org/docs/contributing/) document we would love to have you.
|
|
|
|
Want to say thanks? Click the ⭐ at the top of the page.
|
|
|
|
## Key Links
|
|
|
|
- Actual [discord](https://discord.gg/pRYNYr4W5A) community.
|
|
- Actual [Community Documentation](https://actualbudget.org/docs)
|
|
- [Frequently asked questions](https://actualbudget.org/docs/faq)
|
|
|
|
## Installation
|
|
|
|
There are four ways to deploy Actual:
|
|
|
|
1. One-click deployment [via PikaPods](https://www.pikapods.com/pods?run=actual) (~1.40 $/month) - recommended for non-technical users
|
|
1. Managed hosting [via Fly.io](https://actualbudget.org/docs/install/fly) (~1.50 $/month)
|
|
1. Self-hosted by using [a Docker image](https://actualbudget.org/docs/install/docker)
|
|
1. Local-only apps - [downloadable Windows, Mac and Linux apps](https://actualbudget.org/download/) you can run on your device
|
|
|
|
Learn more in the [installation instructions docs](https://actualbudget.org/docs/install/).
|
|
|
|
## Ready to Start Budgeting?
|
|
|
|
Read about [Envelope budgeting](https://actualbudget.org/docs/getting-started/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](https://actualbudget.org/docs/getting-started/starting-fresh) guide so you can quickly get up and running!
|
|
|
|
### Are you migrating from other budgeting apps?
|
|
|
|
Check out the community's [Migration](https://actualbudget.org/docs/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](https://actualbudget.org/docs), 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](https://actualbudget.org/docs/contributing/).
|
|
|
|
### Code structure
|
|
|
|
The Actual app is split up into a few packages:
|
|
|
|
- loot-core - The core application that runs on any platform
|
|
- desktop-client - The desktop UI
|
|
- desktop-electron - The desktop app
|
|
|
|
More information on the project structure is available in our [community documentation](https://actualbudget.org/docs/contributing/project-details).
|
|
|
|
### Feature Requests
|
|
|
|
Current feature requests can be seen [here](https://github.com/actualbudget/actual/issues?q=is%3Aissue+label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc).
|
|
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](https://actualbudget.org/docs/contributing/i18n/) of Actual. We are using a crowd sourcing tool to manage the translations, see our [Weblate Project](https://hosted.weblate.org/projects/actualbudget/). Weblate proudly supports open-source software projects through their [Libre plan](https://weblate.org/en/hosting/#libre).
|
|
|
|
<a href="https://hosted.weblate.org/engage/actualbudget/">
|
|
<img src="https://hosted.weblate.org/widget/actualbudget/actual/287x66-grey.png" alt="Translation status" />
|
|
</a>
|
|
|
|
## Repo Activity
|
|
|
|
|
|
|
|
## Sponsors
|
|
|
|
Thanks to our wonderful sponsors who make Actual Budget possible!
|
|
|
|
<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-accent.svg" alt="Deploys by Netlify" /> </a>
|