Skip to content

Getting Started

This guide will help you set up and start using Ledgerly.

Prerequisites

  • Python 3.12+
  • Node.js 18+
  • PostgreSQL 12+
  • UV (Python package manager)

Installation

Backend Setup

cd backend
make install          # Install dependencies
make init            # Initialize database (migrations + seed data)
make runserver       # Start development server

Frontend Setup

cd frontend
npm install          # Install dependencies
npm run dev          # Start development server

First Steps

1. Create Your First Currency

Currencies are automatically seeded when you run make init. If you need additional currencies, you can create them through the admin interface or API.

2. Create Your Account Structure

Start by creating your main accounts:

  1. Assets (what you own):
  2. Cash
  3. Bank Accounts (Checking, Savings)

  4. Investments

  5. Liabilities (what you owe):

  6. Credit Cards
  7. Loans

  8. Mortgages

  9. Income (money coming in):

  10. Salary
  11. Freelance

  12. Investments

  13. Expenses (money going out):

  14. Food & Dining
  15. Transportation
  16. Utilities

  17. Entertainment

  18. Equity (net worth):

  19. Opening Balances
  20. Retained Earnings

3. Create Your First Transaction

A transaction in Ledgerly follows double-entry accounting principles:

  • Every transaction must have at least 2 entries
  • Total debits must equal total credits
  • Each entry affects one account

Example: Paying $50 for groceries with cash

  • Debit: Expenses:Food & Dining → $50 (money going out)
  • Credit: Assets:Cash → $50 (cash decreasing)

4. Explore the Dashboard

The dashboard shows: - Monthly income, expenses, and savings - Category breakdown - Cash flow over time - Account balances

Next Steps