rafaelcaricio/actual
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A local-first personal finance system
57 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
Tom French 159d53260d chore: delete unused directory browser/build
2022-07-07 18:27:26 -04:00
.circleci style: fix yaml formatting in CI config 2022-06-29 10:02:43 -04:00
.github ci: re-add runner os specific caches 2022-06-29 13:24:34 -04:00
bin ci: avoid attempting to get CSC_KEY_PASSWORD interactively in github actions 2022-06-29 13:24:34 -04:00
data Initial (open-source) 2022-04-28 22:44:38 -04:00
docs Initial (open-source) 2022-04-28 22:44:38 -04:00
packages chore: delete unused directory browser/build 2022-07-07 18:27:26 -04:00
patches Initial (open-source) 2022-04-28 22:44:38 -04:00
.editorconfig Create .editorconfig 2022-04-30 12:17:49 -04:00
.gitattributes Initial (open-source) 2022-04-28 22:44:38 -04:00
.gitignore chore: add log files to gitignore 2022-06-29 09:56:37 -04:00
CONTRIBUTING.md cleanup 2022-04-29 02:02:46 -04:00
jest-babel-transformer-esm.js Initial (open-source) 2022-04-28 22:44:38 -04:00
jest-babel-transformer.js Initial (open-source) 2022-04-28 22:44:38 -04:00
jest.config.js Initial (open-source) 2022-04-28 22:44:38 -04:00
LICENSE.txt license 2022-04-29 10:40:12 -04:00
package.json build: remove unused yarn scripts 2022-06-29 09:57:21 -04:00
README.md docs: remove holiday text from README 2022-07-07 18:20:42 -04:00
yarn.lock build: update downshift patch to match installed version 2022-06-29 13:31:10 -04:00

README.md

This is the source code for Actual, a local-first personal finance tool. It is 100% free and open-source.

If you are only interested in running the latest version, you don't need this repo. You can get the latest version through npm.

More docs are available in the docs folder.

If you are interested in contributing, or want to know how development works, see CONTRIBUTING.md

Join the discord!

Installation

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.

git clone https://github.com/actualbudget/actual-server.git
cd actual-server
yarn install
yarn start

Navigate to https://localhost:5006 in your browser and you will see Actual.

You should deploy the server somewhere so you can access your data from anywhere. See instructions on the actual-server repo.

Without a server

This will give you a fully local web app without a server. This npm package is the packages/desktop-client package in this repo built for production:

yarn add @actual-app/web

Now you need to serve the files in node_modules/@actual-app/web/build. One way to do it:

cd node_modules/@actual-app/web/build
npx http-server .

Navigate to http://localhost:8080 and you should see Actual.

Building

If you want to build the latest version, see releasing.md. It provides instructions for building this code into the same artifacts that come from npm.

Run locally

Both the electron and web app can started with a single command. When running in development, it will store data in a data directory in the root of the actual directory.

First, make sure to run yarn install to install all dependencies.

In the root of the project:

yarn start            # Run the electron app
yarn start:browser    # Run the web app

Code structure

The 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
  • mobile - The mobile app

More docs are available in the docs folder.