TrueLedger Documentation¶

Welcome to the TrueLedger documentation! TrueLedger is a privacy-first, offline-first personal finance tracker with AI-powered insights.

🌐 Live Web Demo¶

🌟 Key Features¶

💰 Complete Financial Tracking: Track income, expenses, budgets, and saving goals
🤖 AI-Powered Insights: Get intelligent forecasts and personalized financial advice
🔒 Privacy First: All data stored locally with optional encryption (View Policy)
📊 Beautiful Analytics: Visualize your financial health with interactive charts
🌙 Modern UI: Dark mode, smooth animations, and premium design
📱 Cross-Platform: Available on Android, iOS, Linux, macOS, Windows, and Web

🚀 Quick Links¶

Getting Started

Install TrueLedger and start tracking your finances in minutes

Installation Guide
Architecture

Learn about the Clean Architecture pattern and project structure

Architecture Overview
Development

Contribute to TrueLedger and add new features

Development Guide
Testing

Write and run tests for quality assurance

Testing Guide

📖 What's Inside¶

This documentation covers:

Getting Started: Installation, configuration, and quick start guides.
Architecture: Deep dive into Clean Architecture, layers, and design patterns.
Development: How to add features, write tests, and follow best practices.
Features: Detailed guides for Dashboard, Transactions, Budgets, and AI Insights.
Database: Schema, migrations, and performance optimization.
Platform-Specific: Implementation details for Web, Android, iOS, and Desktop.
CI/CD: Continuous integration and deployment workflows.

🏗️ Architecture at a Glance¶

TrueLedger follows Clean Architecture principles with four distinct layers:

┌─────────────────────────────────────────┐
│         Presentation Layer              │
│  (UI, Screens, Widgets, Providers)      │
└─────────────────────────────────────────┘
                  ↓
┌─────────────────────────────────────────┐
│          Domain Layer                   │
│  (Use Cases, Models, Repositories)      │
└─────────────────────────────────────────┘
                  ↓
┌─────────────────────────────────────────┐
│           Data Layer                    │
│  (Repository Impl, Data Sources)        │
└─────────────────────────────────────────┘
                  ↓
┌─────────────────────────────────────────┐
│           Core Layer                    │
│  (Utils, Services, Constants)           │
└─────────────────────────────────────────┘

Learn more about the architecture →

🎯 Philosophy¶

TrueLedger is built with these core principles:

Privacy First: Your financial data never leaves your device
Offline First: Full functionality without internet connection
User Experience: Beautiful, intuitive, and delightful to use
Code Quality: Clean, testable, and maintainable codebase
Cross-Platform: One codebase, six platforms

🤝 Contributing¶

We welcome contributions! Check out our Contributing Guidelines to get started.

📄 License¶

TrueLedger is open source software. See the repository for license details.

Ready to dive in? Start with the Installation Guide or explore the Architecture Overview.