Skip to content

Installation Guide

Get TrueLedger up and running on your platform of choice.

Prerequisites

  • Flutter SDK: Version 3.0 or higher
  • Dart SDK: Version 3.0 or higher
  • Platform-specific tools:
  • Android: Android Studio with Android SDK
  • iOS: Xcode (macOS only)
  • Linux: libsecret-1-dev, libjsoncpp-dev
  • macOS: Xcode Command Line Tools
  • Windows: Visual Studio 2022 with C++ tools
  • Web: Chrome, Edge, or Firefox (SQLite WASM requires a modern browser)

Quick Install

1. Clone the Repository

git clone https://github.com/satyakommula96/trueledger.git
cd trueledger

2. Install Dependencies

flutter pub get

3. Platform-Specific Setup

# No additional setup required
flutter run -d android

cd ios
pod install
cd ..
flutter run -d ios

# Install dependencies
sudo apt-get update
sudo apt-get install -y \
  libsecret-1-dev \
  libjsoncpp-dev \
  libsqlite3-dev \
  libsqlcipher-dev \
  libssl-dev

flutter run -d linux

# Ensure Xcode Command Line Tools are installed
xcode-select --install

# Install SQLCipher for database encryption
brew install sqlcipher

flutter run -d macos

# Ensure Visual Studio 2022 with C++ tools is installed
# Note: For encryption, provide sqlcipher.dll (e.g., from Zetetic or vcpkg) in the application directory
flutter run -d windows

flutter run -d chrome

Verify Installation

Run the test suite to ensure everything is working:

flutter test

All 21 tests should pass: - ✅ 19 Unit tests - ✅ 1 Widget test - ✅ 1 Integration test

Build for Production

Android APK

flutter build apk --release

Output: build/app/outputs/flutter-apk/app-release.apk

iOS IPA

flutter build ios --release

Then use Xcode to create an archive and export the IPA.

Linux

flutter build linux --release

Output: build/linux/x64/release/bundle/

macOS

flutter build macos --release

Output: build/macos/Build/Products/Release/trueledger.app

Windows

flutter build windows --release

Output: build/windows/runner/Release/

Web

flutter build web --release

Output: build/web/

Deployment Tip

The web version is a Single Page Application (SPA). For production deployment (like the Live Demo), ensure your server is configured to redirect all traffic to index.html. See the Web Platform Guide for more.

Troubleshooting

Common Issues

"Flutter SDK not found"

# Add Flutter to PATH
export PATH="$PATH:/path/to/flutter/bin"

"Android licenses not accepted"

flutter doctor --android-licenses

"CocoaPods not installed" (iOS/macOS)

sudo gem install cocoapods

"libsecret not found" (Linux)

sudo apt-get install libsecret-1-dev

Still Having Issues?

  1. Run flutter doctor to diagnose problems
  2. Check the GitHub Issues
  3. Review platform-specific guides in the Platforms section

Next Steps