rafaelcaricio/actual
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A local-first personal finance system
180 commits 10 branches 0 tags 38 MiB
JavaScript 91.4%
C++ 5.2%
C 1.5%
M4 0.4%
Objective-C 0.3%
Other 1%
Find a file
Rich In SQL a582975d71 Update README.md 
Readme updates
2022-10-21 10:26:47 +01:00
.github Update stale.yml 2022-10-20 07:37:53 +01:00
.yarn chore: update to yarnv3 and fix missing packages preventing install 2022-08-22 22:35:07 -04:00
bin chore: update package scripts to take advantage of yarn v3 2022-08-22 22:35:07 -04:00
data Initial (open-source) 2022-04-28 22:44:38 -04:00
docs Add docs for building for windows (contributed by @ejmurra) 2022-08-12 09:48:38 -04:00
packages Render a schedule rule with the mapped payee id; fixes crash 2022-10-05 20:14:04 -04:00
patches fix: move downshift patch to monorepo root 2022-08-22 22:35:07 -04:00
.editorconfig Create .editorconfig 2022-04-30 12:17:49 -04:00
.eslintrc.js Sort import in alphabetical order (#238) 2022-09-02 15:07:24 +01:00
.gitattributes Initial (open-source) 2022-04-28 22:44:38 -04:00
.gitignore chore: update to yarnv3 and fix missing packages preventing install 2022-08-22 22:35:07 -04:00
.nvmrc build: fix offical node version to 16.15.0 2022-07-07 18:27:52 -04:00
.prettierrc.json style: switch prettier to enforce single quotes 2022-07-24 08:53:04 +01:00
.yarnrc.yml chore: update to yarnv3 and fix missing packages preventing install 2022-08-22 22:35:07 -04:00
CONTRIBUTING.md cleanup 2022-04-29 02:02:46 -04:00
LICENSE.txt license 2022-04-29 10:40:12 -04:00
package.json ci: lint desktop-client in CI 2022-08-25 16:21:26 +01:00
README.md Update README.md 2022-10-21 10:26:47 +01:00
tsconfig.json fix: add esModuleInterop so that the default imports issue goes away 2022-08-24 21:09:45 +01:00
yarn.lock Separate external, monorepo and internal imports (#237) 2022-09-02 12:43:37 +01:00

README.md

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 CONTRIBUTING.md we would love to have you.

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

Key Links

Installation

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.

Please Note: While the Actual repository holds source code for the mobile applications that were supported when Actual was closed source, these are no longer supported on the Open Source version of Actual.

The easy way: using a server (recommended)

The easiest way to get Actual running is to use the 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.

You can get up and running quickly and easily by following our Running Actual Locally Guide

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.

Code structure

The Actual app is split up into a few packages:

  • 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

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