Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bios-marcel/baka

My stupid personal financial management
https://github.com/bios-marcel/baka

java javafx openjfx

Last synced: 3 months ago
JSON representation

My stupid personal financial management

Awesome Lists containing this project

README

        

stonks man

A simple visualisation tool for personal finances.
Merge different bank accounts histories together, classify payments and do predictions.

## Concept

This application DOES NOT connect to your bank or your bank account in any way. No data is sent anywhere.
It uses Export-Formats offered by your bank. Currently, there are a couple of hard-coded ones that I am using for test
purposes. The plan is to have a configurable CSV importer, as most banks seem to offer CSV exporting.

## Data Storage

For storage, we are using `Eclipse Store` (previously `MicroStream`). The data is stored in `$env.APPDATA`.

In order to delete the data, simply remove `$env.APPDATA/baka`.

## Installation

### Windows

An installer can be built via maven:

```shell
./gradlew build jpackage
```

Updating an existing installation does not work correctly as of now.
To update, a manual uninstallation is required before installation.

Pre-built installers are also available as build artifacts.

### Other systems

TODO

## Development

### Requirements

* Required
* OpenJDK 22
* Optional
* Building a Windows installer: https://github.com/wixtoolset/wix3/releases

The build system is provided with the code. While you could invoke a pre-installed `gradle`, it is recommended to
use `./gradlew` instead, as this will get a specific gradle version, preventing compatibility issues.

### Debug Mode

The debug mode offers additional (potentially dangerous) features. It can be toggled via `Ctrl + Shift + D`.