Architectural design of the project on Pledger.io

The business domain of Pledger.io

Mon, 01 Jan 0001 00:00:00 +0000

The diagram below depicts the domain model that is used in Pledger.io. In this domain you can clearly see that the Transaction is linked to the Account using at least two Parts. It also indicates that there are multiple concepts that describe the context of a transaction, these are:

Budget
Category
Tag
Contract

Domain model

In this design the choice was made to attach everything on a UserAccount. Where the Account is the primary entity, with an enumeration in it to indicate the type of account.

The backend design for Pledger.io

Mon, 01 Jan 0001 00:00:00 +0000

The REST-api is the main part of the application. This is a Java base web application that contains all the business logic for Pledger.io. The user interface is bundled into the application by the Deployment setup.

Used tooling

This part of Pledger.io is build using the following tooling:

Gradle, used as the build tool.
Micronaut framework, used as the DI and API framework.
LangChain4j, used as the engine to interact with Vector stores and LLM implementations.

Rest design

The REST interface is designed contract-first. This means that all APIs are designed in an Open API Specification file and interfaces are generated using Micronaut.

The UI design for Pledger.io

Mon, 01 Jan 0001 00:00:00 +0000

The user interface is a React-based application. It is built up using the following frameworks and tools:

React, used as the UI framework.
Typescript, used as the programming language.
Chart.js, used for the rendering of the various charts inside the application.
Primereact, used as the primary UI component library for the application.
axios, used for the communication with the REST-api.

Overview

The Pledger.io application follows a layered architecture pattern, separating concerns into distinct layers that interact with each other in a controlled manner. This document describes the high-level architecture of the application, including its main layers and components.

Deployment strategy for Pledger.io

Mon, 01 Jan 0001 00:00:00 +0000

The deployment repository is used to bundle the user-interface and REST-api into a single deployable artifact. This repository is built using the following tooling:

Gradle, used as the build tool.
Docker, used to create the docker images.
Electron, used to create the desktop application.

Build process

Pulling the latest version of the user-interface and REST-api.
Building an output archive for the combined REST-api and user-interface.
Building a docker image for the combined REST-api and user-interface.
Building an electron application for the combined REST-api and user-interface.
Pushing the docker image to the docker registry.
Pushing the desktop application to the release repository.

Repositories involved for Pledger.io

Mon, 01 Jan 0001 00:00:00 +0000

Pledger.io is a web application that consists out of several repositories. Each of the repositories has a dedicated goal and is designed to be bundled into a single application.

At this point in time, the following repositories are available:

Code repositories

rest-application, the main application repository containing the Java REST-api.
user-interface, the React based user interface.
build-tooling, the deployment repository bundling the user-interface and rest-application artifacts.

Documentation repositories

user-documentation, the repository that generates this website.
importer-configuration, the repository containing the default configuration for the CSV-based transaction importer.