actual - 地域初の個人金融システム

(A local-first personal finance system)

Created at: 2022-04-29 10:41:34
Language: JavaScript
License: MIT

これは、ローカルファーストの個人金融ツールであるActualのソースコードです。100%無料でオープンソースです。

最新バージョンの実行のみに興味がある場合は、このリポジトリは必要ありません。最新バージョンは npm から入手できます。

docs フォルダには、さらに多くのドキュメントがあります

貢献することに興味がある場合、または開発の仕組みを知りたい場合は、以下を参照してくださ CONTRIBUTING.md

不和に加わろう!

取り付け

簡単な方法:サーバーを使用する(推奨)

Actual を実行する最も簡単な方法は、実績サーバー プロジェクトを使用することです。これは、デバイス間で変更を同期するためのサーバーであり、最新バージョンのActualが付属しています。サーバーは、同期用の Web プロジェクトとサーバーの両方を提供します。

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

ブラウザで https://localhost:5006 に移動すると、「実績」が表示されます。

どこからでもデータにアクセスできるように、サーバーをどこかに展開する必要があります。実際のサーバーリポジトリの手順を参照してください。

サーバーなし

これにより、サーバーなしで完全にローカルなWebアプリケーションが得られます。このnpmパッケージは、本番環境向けに構築されたこのリポジトリのパッケージです。

packages/desktop-client

yarn add @actual-app/web

次に、 のファイルを提供する必要があります。それを行う1つの方法:

node_modules/@actual-app/web/build

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

http://localhost:8080 に移動すると、「実績」と表示されます。

建物

最新バージョンをビルドする場合は、「releasing.md」を参照してください。このコードを npm から取得されるのと同じ成果物にビルドするための手順を提供します。

ローカルで実行

電子アプリとウェブアプリの両方を1つのコマンドで起動できます。開発中に実行すると、ディレクトリのルートにあるディレクトリにデータが格納されます。

data
actual

まず、実行してすべての依存関係をインストールしてください。

yarn install

プロジェクトのルートで、次の操作を行います。

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

コード構造

アプリはいくつかのパッケージに分割されます。

  • 戦利品コア - 任意のプラットフォーム上で実行されるコアアプリケーション
  • 戦利品デザイン - UIを構成する一般的なデザインコンポーネント
  • デスクトップ クライアント - デスクトップ UI
  • デスクトップ電子 - デスクトップアプリ
  • モバイル - モバイルアプリ

docs フォルダには、さらに多くのドキュメントがあります