Pay My Buddy

PayMyBuddy enables the sharing of real world currency between users in a simple, fast, and secure manner.

Table of contents

• Pay My Buddy
  • Table of contents
  • Tech stack
    • Database
    • Backend
    • Frontend
  • Running the application
    • Gradle
    • Container
  • Database schema
  • Testing
    • Coverage
    • Test execution
    • Mutation

Tech stack

Database

• PostgreSQL: SQL database.
• SQLx: Simple SQL migration.

Backend

• Gradle: Integrated build tool with gradlew.
• Java >=21.
• Spring boot: Configure a Spring project.

Frontend

• Thymeleaf: Java templating engine.
• TailwindCSS: CSS framework.

Running the application

There are 2 different way to run this application:

Gradle

Run the tests using:

./gradlew test

Run the mutation tests using:

./gradlew pitest

Build the application as an uber JAR (a JAR containing all of its dependencies) using:

./gradlew bootJar
java -jar build/**.jar # Run

Run the application using:

cp .env.CHANGEME .env
# Edit the `DATABASE_**` variables to match your PostgreSQL instance
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh # Install Rust, used to install the migration tool
cargo install sqlx-cli
sqlx database setup
./gradlew bootRun

Container

You can run the application using an OCI compliant container engine (like Docker or Podman) that supports the compose specification.

# Using Docker
docker-compose up -d
# Using Podman
podman-compose up -d

Database schema

Testing

This application was tested on a Linux machine (Ubuntu 24.10 x86_64).

Coverage

Test execution

Mutation