Skip to content

h4llow3En/Piggy

Repository files navigation

Piggy Logo

Piggy

Self-hosted Financial Planning & Budgeting

CI/CD Status License Backend Frontend Coverage


Piggy is a self-hosted personal finance application designed to provide clear insights into individual and shared finances. By aggregating banking data and providing structured visualization, Piggy helps to manage budgets, track spending habits and maintain a clear overview of financial health, all while keeping data private and under your control.


Key Features

  • Transaction Import Fetching transactions from the bank via FinTS (HBCI) (currently only DKB implemented).
  • Financial Analytics Detailed visualization of cashflow, account balances, and spending patterns using interactive charts.
  • Budget Management Define and monitor category-based budgets with real-time progress tracking.
  • Recurring Payments Automated detection and forecasting of subscriptions and regular expenses for accurate balance prognosis.
  • Mobile-Optimized PWA Fully responsive interface, installable as a Progressive Web App for a native-like mobile experience.
  • Multi-User & Internationalization Support for multiple users with role-based access control and full localization in English and German.
  • Theming Native support for Light and Dark modes, respecting system preferences.

Quick Start

Deploy your personal instance using Docker.

  1. Start the environment: Create a .env file based on .env.example and then run:

    docker compose up -d

    Note: The default configuration expects a reverse proxy like Traefik. Otherwise, the frontend will not be able to access the API.

  2. Access the services:

  3. Initial Setup: Create your account via the registration flow. The first registered user is automatically assigned administrative privileges.


Roadmap

  • Mail Templates Fix and extend existing mail templates for better user notifications.
  • Exports Refresh and fix data export functionality (CSV, PDF, etc.).
  • Bank Support Support for additional banks in the FinTS client. Help wanted, as this requires testing with actual bank accounts.
  • Suggestions Add recurring payment suggestions endpoint to frontend.

Security & Privacy

  • Self-Hosted Your financial data remains on your infrastructure.
  • Security Best Practices Docker images are configured to run as non-root users.
  • Robust Authentication JWT-based authentication with secure refresh token logic and bcrypt password hashing.

Control your money, don't let your money control you.

About

Piggy is a self-hosted personal finance application designed to provide clear insights into individual and shared finances

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors