@* ── Getting Started ── *@

🚀 Getting Started

Welcome to Budgeteer — a personal finance dashboard to track your accounts, transactions and spending categories.

Create an account — Head to Accounts and add at least one financial account (e.g. "Current Account", "Savings"). Set the opening balance and choose a currency.
Set up categories — Visit Categories to organise your spending. A set of default categories (including Salary) are provided automatically.
Configure your salary — Visit Salary to add your regular income sources. Each salary generates recurring Income transactions automatically and highlights paydays on the chart.
Record transactions — Go to Transactions or use the + Add button on the Dashboard to log income and expenses.
Review your dashboard — The Dashboard shows a balance trend chart and lists your recent and upcoming transactions.

@* ── Dashboard ── *@

📊 Dashboard

The Dashboard is your home screen and gives you an at-a-glance view of your finances.

Balance Trend Chart

The chart shows projected balances for each account over a time window starting from today. Use the preset buttons (7d, 30d, 90d, 1y) to look ahead, or pick custom dates with the date pickers. Payday dates from your Salary sources are highlighted with a 💰 marker and a subtle green band.

Recent & Upcoming Tabs

Recent — Transactions that have already occurred, sorted by most recent first.
Upcoming — Future transactions (including recurring ones) with projected account balances shown alongside each entry.

Quick Actions

Click a transaction to expand it and reveal Edit and Delete buttons.
Use the search box to filter by description, account, category or amount.
When you have multiple accounts, use the account filter buttons below the tabs to show or hide specific accounts.
The + Add button opens a quick-add modal — after saving, the form stays open so you can add multiple transactions in a row.

@* ── Accounts ── *@

🏦 Accounts

The Accounts page lets you manage your financial accounts.

Add an account — Enter a name, starting balance, currency and colour. The colour is used throughout the app to identify the account.
Edit — Click the Edit button on any account card to change its name, currency or colour.
Adjust balance — Click the displayed balance amount to manually correct it.
Delete — Removes the account and all associated transactions. This cannot be undone.

Account balances are also shown in the navigation sidebar — click them to jump to the Accounts page.

@* ── Transactions ── *@

💸 Transactions

The Transactions page provides a full sortable and searchable table of all your transactions.

Adding a Transaction

Fill in the description, amount, date, type (Income or Expense), account and optionally a category.
Amounts are always entered as positive numbers — the type field determines whether it adds to or subtracts from the account balance.

Recurring Transactions

Set a recurrence of Daily, Weekly, Monthly or Yearly when creating a transaction.
Optionally set an end date (up to 1 year from the transaction date). If left blank, it defaults to 1 year.
Future occurrences appear in the Upcoming tab on the Dashboard.
When editing a recurring transaction, changes apply to that occurrence and all future ones in the series.
When deleting, you can choose to delete just one occurrence or the entire future series.

Sorting & Filtering

Click any column header to sort the table.
Use the search box and account/type/category drop-downs to narrow results.
Select multiple transactions with checkboxes for bulk deletion.

@* ── Salary ── *@

💰 Salary

The Salary page lets you define regular income sources that generate recurring transactions automatically.

Adding a Salary

Name — A label for this income source (e.g. "Main Job", "Freelance").
Amount — The net amount credited each payday.
Account — Which account receives the payment.
Recurrence — How often you are paid: Weekly, Monthly or Yearly.
First Payday — The date of the first payment. The day of month (or week) is derived from this and repeats indefinitely.

How Salary Transactions Work

Salary transactions are generated automatically as Income entries up to the end of the current time window, and refreshed whenever you visit or change the date range on any page.
They appear on the Transactions page with a 💰 badge and cannot be deleted from there — manage them on the Salary page instead.
Payday dates are highlighted on the Dashboard balance chart with a 💰 marker and subtle green band so you can see upcoming income at a glance.
The category is automatically set to Salary.

Deleting a Salary

Deleting a salary removes all future unpaid transactions for that income source. Past transactions remain in your history for accurate record-keeping.

@* ── Categories ── *@

🏷️ Categories

The Categories page lets you create and manage spending categories.

Add a category — Enter a name and pick an emoji icon from the icon picker.
Edit — Click the Edit button on a category card to change its name or icon.
Delete — Removes the category. Transactions using it will become uncategorised.
Default categories — A set of built-in categories (Groceries, Salary, Rent / Mortgage, etc.) are created automatically and shown with a Default badge. These cannot be edited or deleted.

Categories are optional — you can assign them to transactions to get better insight into your spending patterns.

@* ── Reports ── *@

📈 Reports

The Reports page gives you a visual breakdown of your spending and income over a chosen time period.

Filters

Use the preset buttons (7d, 30d, 90d, 1y) or pick custom start/end dates to set the time range.
Toggle individual accounts on or off to include or exclude them from the charts and summary.

Charts

Expenses by Category — a doughnut chart showing how your spending is distributed across categories.
Income by Category — a doughnut chart showing the sources of your income.
Monthly Income vs Expenses — a bar chart comparing total income and expenses for each month in the selected range.

Category Summary Table

Below the charts is a table listing every category with its total income, total expenses and net amount. A totals row at the bottom shows the overall figures for the period.

@* ── Settings ── *@

⚙️ Settings

The Settings page provides account management options:

Change password — Enter your current password and choose a new one.
Reset data — Wipe all your accounts, transactions and categories to start fresh. Your login credentials are kept.
Delete account — Permanently removes your user account and all associated data. This action cannot be undone.

@* ── Tips ── *@

💡 Tips

Use the Dashboard + Add button for rapid entry — the modal stays open after each save so you can batch-add transactions.
Set up recurring transactions for regular bills and income to keep your upcoming view accurate.
Use the Salary page for regular pay — it is protected from accidental deletion and highlights paydays on the chart. Use the 90d or 1y window to plan ahead.
Assign colours to your accounts to easily distinguish them on the chart and in transaction lists.
Hover over elements for tooltips with additional context throughout the app.
Click your account balances in the sidebar to quickly navigate to account management.

@* ── Sidebar quick links ── *@

Quick Navigation

📊 Dashboard 🏦 Accounts 💸 Transactions 💰 Salary 🏷️ Categories 📈 Reports ⚙️ Settings 💡 Tips

About Budgeteer

Help