Skip to content
Snippets Groups Projects
README.md 2.28 KiB
Newer Older
<p align="center">
  <img src="/demo.png" alt="Actualbudget" />
</p>

Rich In SQL's avatar
Rich In SQL committed
## Getting Started
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
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.
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
If you are interested in contributing, or want to know how development works, see [CONTRIBUTING.md](https://github.com/actualbudget/actual/blob/master/CONTRIBUTING.md) we would love to have you.
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
Want to say thanks? Click the ⭐ at the top of the page.
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
## Key Links
James Long's avatar
James Long committed

- Actual [discord](https://discord.gg/pRYNYr4W5A) community.
- Actual [Community Documentation](https://actualbudget.github.io/docs)
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
## Installation
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
If you are only interested in running the latest version and not contributing to the source code, you don't need to clone this repo. You can get the latest version through npm.
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
### The easy way: using a server (recommended)
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
The easiest way to get Actual running is to use the [actual-server](https://github.com/actualbudget/actual-server) project. That is the server for syncing changes across devices, and it comes with the latest version of Actual. The server will provide both the web project and a server for syncing.
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
You can get up and running quickly and easily by following our [Running Actual Locally Guide](https://actualbudget.github.io/docs/Installing/Local/your-own-machine)
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
## Documentation
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
We have a wide range of documentation on how to use Actual, this is all available in our [Community Documentation](https://actualbudget.github.io/docs), this includes topics on Budgeting, Account Management, Tips & Tricks and some documentation for developers.
James Long's avatar
James Long committed

## Code structure

Rich In SQL's avatar
Rich In SQL committed
The Actual app is split up into a few packages:
James Long's avatar
James Long committed

- loot-core - The core application that runs on any platform
- loot-design - The generic design components that make up the UI
- desktop-client - The desktop UI
- desktop-electron - The desktop app
James Long's avatar
James Long committed

Rich In SQL's avatar
Rich In SQL committed
More information on the project structure is available in our [community documentation](https://actualbudget.github.io/docs/Developers/project-layout).

## 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>