Product documentation · Backend technical docs
Pledger.io is a "self hosted" application that helps in keeping track of your personal finances. It helps you keep track of your income and expenses to allow you to spend less money and save more.
Using Pledger.io you can keep track of your income vs spending as well as your credit card expenses. Pledger.io has the following features:
- Categories to group expenses
- Budgets to track income vs. expenses
- Contract notifications
- Importing transactions from bank exports
Note: the front-end application can be found in the user-interface repository. The deployment build will bundle the front-end with this backend system.
In this repository you will find the backend REST application needed to run Pledger.io.
To build the application the following needs to be present on your local PC:
- JDK 25 (Temurin or compatible; matches CI)
- Git for completing the checkout
You can build the application using the Gradle command:
./gradlew build
Run from Gradle (demo profile with in-memory H2):
./gradlew run -Dmicronaut.environments=jpa,demo
Or start the fat JAR produced under build/libs/ (artifact name pledger-io):
java -jar build/libs/pledger-io-*.jar
To access the API documentation use the url:
http://localhost:8080/spec/index.html
For architecture, ADRs, and further setup notes see docs/.