Skip to content

Pledger.io is a "self hosted" application that helps in keeping track of your personal finances.

License

Notifications You must be signed in to change notification settings

pledger-io/rest-application

Repository files navigation

Pledger.io

Sonatype Nexus (Releases) Release Build Quality Gate Status Coverage License: MIT


Read the documentation


About Pledger.io

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 many 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

Get started

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.

Building the source

To build the application the following needs to be present on your local PC:

  • JDK 21 or higher
  • GIT for completing the checkout

You can build the application using the Gradle command:

./gradlew build

Running the backend

The generated phat JAR in the fintrack-api module can be started, which will run the backend of Pledger.io. To access the API documentation use the url:

http://localhost:8080/spec/index.html