{"id":13906556,"url":"https://github.com/andreasgerstmayr/fava-dashboards","last_synced_at":"2026-06-08T23:01:25.195Z","repository":{"id":145325477,"uuid":"611467725","full_name":"andreasgerstmayr/fava-dashboards","owner":"andreasgerstmayr","description":"Custom Dashboards for Beancount in Fava","archived":false,"fork":false,"pushed_at":"2026-05-08T16:43:07.000Z","size":51544,"stargazers_count":379,"open_issues_count":3,"forks_count":37,"subscribers_count":10,"default_branch":"main","last_synced_at":"2026-05-08T18:39:15.254Z","etag":null,"topics":["beancount","charts","dashboards","fava","sankey"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andreasgerstmayr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2023-03-08T22:14:19.000Z","updated_at":"2026-05-08T16:42:26.000Z","dependencies_parsed_at":"2023-12-01T21:23:38.382Z","dependency_job_id":"8a217805-f328-4b90-89ed-d4ed91a003d1","html_url":"https://github.com/andreasgerstmayr/fava-dashboards","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/andreasgerstmayr/fava-dashboards","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreasgerstmayr%2Ffava-dashboards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreasgerstmayr%2Ffava-dashboards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreasgerstmayr%2Ffava-dashboards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreasgerstmayr%2Ffava-dashboards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andreasgerstmayr","download_url":"https://codeload.github.com/andreasgerstmayr/fava-dashboards/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreasgerstmayr%2Ffava-dashboards/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34083848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beancount","charts","dashboards","fava","sankey"],"created_at":"2024-08-06T23:01:38.178Z","updated_at":"2026-06-08T23:01:25.185Z","avatar_url":"https://github.com/andreasgerstmayr.png","language":"TypeScript","funding_links":[],"categories":["Plugins","TypeScript"],"sub_categories":["Fava"],"readme":"# Fava Dashboards\n[![Continuous Integration](https://github.com/andreasgerstmayr/fava-dashboards/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/andreasgerstmayr/fava-dashboards/actions/workflows/continuous-integration.yml)\n[![PyPI](https://img.shields.io/pypi/v/fava-dashboards)](https://pypi.org/project/fava-dashboards/)\n\nfava-dashboards allows creating custom dashboards in [Fava](https://github.com/beancount/fava).\n\nExample dashboards with random data:\n\u003ca href=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Overview-1-chromium-linux.png\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Dark-Theme-Overview-1-chromium-linux.png\"\u003e\n    \u003cimg alt=\"Overview\" src=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Overview-1-chromium-linux.png\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Assets-1-chromium-linux.png\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Dark-Theme-Assets-1-chromium-linux.png\"\u003e\n    \u003cimg alt=\"Assets\" src=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Assets-1-chromium-linux.png\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Income-and-Expenses-1-chromium-linux.png\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Dark-Theme-Income-and-Expenses-1-chromium-linux.png\"\u003e\n    \u003cimg alt=\"Income and Expenses\" src=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Income-and-Expenses-1-chromium-linux.png\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Sankey-1-chromium-linux.png\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Dark-Theme-Sankey-1-chromium-linux.png\"\u003e\n    \u003cimg alt=\"Sankey\" src=\"https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/snapshots.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Sankey-1-chromium-linux.png\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\n[More screenshots](https://github.com/andreasgerstmayr/fava-dashboards/tree/main/frontend/tests/e2e/snapshots.test.ts-snapshots)\n\n## Installation\n```\npip install fava-dashboards\n```\n\nEnable this plugin in Fava by adding the following lines to your ledger:\n```\n2010-01-01 custom \"fava-extension\" \"fava_dashboards\"\n```\n\n## Configuration\nThe plugin looks by default for a `dashboards.tsx` file (or `.ts`, `.jsx`, `.js`) in the directory of the Beancount ledger (e.g. if you run `fava personal.beancount`, the `dashboards.tsx` file should be in the same directory as `personal.beancount`).\nThe location of the `dashboards.tsx` configuration file can be customized:\n```\n2010-01-01 custom \"fava-extension\" \"fava_dashboards\" \"{\n    'config': '/path/to/dashboards.tsx'\n}\"\n```\n\nTo get TypeScript type support, download [fava-dashboards.d.ts](example/fava-dashboards.d.ts) and place it next to `dashboards.tsx`.\nPlease take a look at the example dashboards configuration [dashboards.tsx](example/dashboards.tsx), which uses most of the functionality described below.\n\nTo convert a legacy `dashboards.yaml` file from version 1 to the new `dashboards.tsx` format, you can run `make deps \u0026\u0026 uv run scripts/convert_dashboards_yaml_to_tsx.py path/to/dashboards.yaml --output path/to/dashboards.tsx`.\nThis script covers most common cases, and does not perform TypeScript type inference.\n\nThe configuration file can contain multiple dashboards, and a dashboard contains one or more panels.\nA panel has a relative width (e.g. `50%` for 2 columns, or `33.3%` for 3 column layouts) and a absolute height.\n\n### Panel Properties\n* `title`: title of the panel. Default: unset\n* `width`: width of the panel. Default: 100%\n* `height`: height of the panel. Default: 400px\n* `link`: optional link target of the panel header.\n* `kind`: panel kind. Must be one of `html`, `echarts`, `d3_sankey`, `table` or `react`.\n* `spec`: a JavaScript function which generates a valid spec depending on the panel `kind`.\n\nThe following variables and functions are available:\n* `panel`: the current panel definition\n* `ledger.dateFirst`: start date of the current date filter, or first transaction date of the ledger\n* `ledger.dateLast`: end date of the current date filter, or last transaction date of the ledger\n* `ledger.filterFirst`: start date of the current date filter, or null if no date filter is set\n* `ledger.filterLast`: end date of the current date filter, or null if no date filter is set\n* `ledger.operatingCurrencies`: configured operating currencies of the ledger\n* `ledger.ccy`: shortcut for the first configured operating currency of the ledger\n* `ledger.accounts`: declared accounts of the ledger\n* `ledger.commodities`: declared commodities of the ledger\n* `ledger.query(bql)`: executes the specified BQL query\n* `ledger.urlFor(url)`: add current Fava filter parameters to url\n\n### HTML panel\nThe `spec` code of HTML panels must return valid HTML.\nThe HTML code will be rendered in the panel.\n\n### ECharts panel\nThe `spec` code of [Apache ECharts](https://echarts.apache.org) panels must return valid [Apache ECharts](https://echarts.apache.org) chart options.\nPlease take a look at the [ECharts examples](https://echarts.apache.org/examples) to get familiar with the available chart types and options.\n\n### d3-sankey panel\nThe `spec` code of d3-sankey panels must return valid d3-sankey chart options.\nPlease take a look at the example dashboard configuration [dashboards.tsx](example/dashboards.tsx).\n\n### Table panel\nThe `spec` code of table panels must return valid [MUI X Data Grid](https://mui.com/x/react-data-grid/) props.\n\n### React panel\nThe `spec` code of React panels must return a valid JSX element.\nPlease note that the code must not return a `Promise` (i.e. `async/await` is not supported).\n\n## View Example Ledger\n`cd example; fava example.beancount`\n\n## Contributing\nThis plugin consists of a Python backend and a TypeScript frontend.\n\nInstall [uv](https://docs.astral.sh/uv/) and Node.js 22, run `make deps` to install the dependencies, and `make dev` to run the Fava dev server with auto-rebuild.\n\nBefore submitting a PR, please run `make build` to build the frontend in production mode, and add the compiled frontend to the PR.\n\n## Articles\n* [Dashboards with Beancount and Fava](https://www.andreasgerstmayr.at/2023/03/12/dashboards-with-beancount-and-fava.html)\n\n## Related Projects\n* [Fava Portfolio Returns](https://github.com/andreasgerstmayr/fava-portfolio-returns)\n* [Fava Investor](https://github.com/redstreet/fava_investor)\n* [Fava Classy Portfolio](https://github.com/seltzered/fava-classy-portfolio)\n\n## Acknowledgements\nThanks to Martin Blais and all contributors of [Beancount](https://github.com/beancount/beancount),\nJakob Schnitzer, Dominik Aumayr and all contributors of [Fava](https://github.com/beancount/fava),\nand to all contributors of [Apache ECharts](https://echarts.apache.org), [D3.js](https://d3js.org) and [d3-sankey](https://github.com/d3/d3-sankey).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreasgerstmayr%2Ffava-dashboards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandreasgerstmayr%2Ffava-dashboards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreasgerstmayr%2Ffava-dashboards/lists"}