Skip to content

getting-started.md

Latest commit

History

History
75 lines (45 loc) · 4.22 KB

getting-started.md

File metadata and controls

75 lines (45 loc) · 4.22 KB
Raw

Getting Started

Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.

1. Add Your First Account

Navigate to the Accounts page from the left sidebar and click Add Account.

Fill in the details:

  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking

Click Save. Repeat for any other accounts you want to track.

Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.

2. Add Transactions

You have two options: import from your bank or add transactions by hand.

Import from your bank

Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.

See Import for the full walkthrough including column mapping and dual-column amount handling.

Add manually

Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.

3. Set Up Categories

Go to the Categories page. You have two options:

  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.

Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.

Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.

4. Create a Budget

Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.

As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.

5. Explore the Dashboard

The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:

  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status

Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.

Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.

What's Next

Now that the basics are in place, explore these features to get more out of Budget:

  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Budget/docs/getting-started.md at master · TheUnderdev/Budget · GitHub
Skip to content
getting-started.md
Latest commit
History
History
75 lines (45 loc) · 4.22 KB
getting-started.md
File metadata and controls
75 lines (45 loc) · 4.22 KB
Raw
Getting Started
Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.
1. Add Your First Account
Navigate to the Accounts page from the left sidebar and click Add Account.
Fill in the details:
  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking
Click Save. Repeat for any other accounts you want to track.
Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.
2. Add Transactions
You have two options: import from your bank or add transactions by hand.
Import from your bank
Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.
See Import for the full walkthrough including column mapping and dual-column amount handling.
Add manually
Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.
3. Set Up Categories
Go to the Categories page. You have two options:
  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.
Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.
Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.
4. Create a Budget
Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.
As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.
5. Explore the Dashboard
The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:
  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status
Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.
Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.
What's Next
Now that the basics are in place, explore these features to get more out of Budget:
  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Budget/docs/getting-started.md at master · TheUnderdev/Budget · GitHub
Skip to content
getting-started.md
Latest commit
History
History
75 lines (45 loc) · 4.22 KB
getting-started.md
File metadata and controls
75 lines (45 loc) · 4.22 KB
Raw
Getting Started
Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.
1. Add Your First Account
Navigate to the Accounts page from the left sidebar and click Add Account.
Fill in the details:
  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking
Click Save. Repeat for any other accounts you want to track.
Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.
2. Add Transactions
You have two options: import from your bank or add transactions by hand.
Import from your bank
Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.
See Import for the full walkthrough including column mapping and dual-column amount handling.
Add manually
Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.
3. Set Up Categories
Go to the Categories page. You have two options:
  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.
Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.
Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.
4. Create a Budget
Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.
As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.
5. Explore the Dashboard
The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:
  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status
Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.
Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.
What's Next
Now that the basics are in place, explore these features to get more out of Budget:
  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Budget/docs/getting-started.md at master · TheUnderdev/Budget · GitHub
Skip to content
getting-started.md
Latest commit
History
History
75 lines (45 loc) · 4.22 KB
getting-started.md
File metadata and controls
75 lines (45 loc) · 4.22 KB
Raw
Getting Started
Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.
1. Add Your First Account
Navigate to the Accounts page from the left sidebar and click Add Account.
Fill in the details:
  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking
Click Save. Repeat for any other accounts you want to track.
Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.
2. Add Transactions
You have two options: import from your bank or add transactions by hand.
Import from your bank
Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.
See Import for the full walkthrough including column mapping and dual-column amount handling.
Add manually
Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.
3. Set Up Categories
Go to the Categories page. You have two options:
  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.
Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.
Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.
4. Create a Budget
Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.
As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.
5. Explore the Dashboard
The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:
  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status
Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.
Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.
What's Next
Now that the basics are in place, explore these features to get more out of Budget:
  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Budget/docs/getting-started.md at master · TheUnderdev/Budget · GitHub
Skip to content
getting-started.md
Latest commit
History
History
75 lines (45 loc) · 4.22 KB
getting-started.md
File metadata and controls
75 lines (45 loc) · 4.22 KB
Raw
Getting Started
Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.
1. Add Your First Account
Navigate to the Accounts page from the left sidebar and click Add Account.
Fill in the details:
  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking
Click Save. Repeat for any other accounts you want to track.
Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.
2. Add Transactions
You have two options: import from your bank or add transactions by hand.
Import from your bank
Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.
See Import for the full walkthrough including column mapping and dual-column amount handling.
Add manually
Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.
3. Set Up Categories
Go to the Categories page. You have two options:
  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.
Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.
Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.
4. Create a Budget
Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.
As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.
5. Explore the Dashboard
The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:
  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status
Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.
Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.
What's Next
Now that the basics are in place, explore these features to get more out of Budget:
  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Budget/docs/getting-started.md at master · TheUnderdev/Budget · GitHub
Skip to content
getting-started.md
Latest commit
History
History
75 lines (45 loc) · 4.22 KB
getting-started.md
File metadata and controls
75 lines (45 loc) · 4.22 KB
Raw
Getting Started
Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.
1. Add Your First Account
Navigate to the Accounts page from the left sidebar and click Add Account.
Fill in the details:
  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking
Click Save. Repeat for any other accounts you want to track.
Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.
2. Add Transactions
You have two options: import from your bank or add transactions by hand.
Import from your bank
Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.
See Import for the full walkthrough including column mapping and dual-column amount handling.
Add manually
Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.
3. Set Up Categories
Go to the Categories page. You have two options:
  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.
Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.
Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.
4. Create a Budget
Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.
As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.
5. Explore the Dashboard
The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:
  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status
Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.
Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.
What's Next
Now that the basics are in place, explore these features to get more out of Budget:
  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Budget/docs/getting-started.md at master · TheUnderdev/Budget · GitHub
Skip to content
getting-started.md
Latest commit
History
History
75 lines (45 loc) · 4.22 KB
getting-started.md
File metadata and controls
75 lines (45 loc) · 4.22 KB
Raw
Getting Started
Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.
1. Add Your First Account
Navigate to the Accounts page from the left sidebar and click Add Account.
Fill in the details:
  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking
Click Save. Repeat for any other accounts you want to track.
Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.
2. Add Transactions
You have two options: import from your bank or add transactions by hand.
Import from your bank
Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.
See Import for the full walkthrough including column mapping and dual-column amount handling.
Add manually
Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.
3. Set Up Categories
Go to the Categories page. You have two options:
  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.
Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.
Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.
4. Create a Budget
Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.
As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.
5. Explore the Dashboard
The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:
  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status
Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.
Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.
What's Next
Now that the basics are in place, explore these features to get more out of Budget:
  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Budget/docs/getting-started.md at master · TheUnderdev/Budget · GitHub
Skip to content
getting-started.md
Latest commit
History
History
75 lines (45 loc) · 4.22 KB
getting-started.md
File metadata and controls
75 lines (45 loc) · 4.22 KB
Raw
Getting Started
Add an account, import or enter transactions, set up categories, create a budget, and explore the dashboard. Takes about 10 minutes.
1. Add Your First Account
Navigate to the Accounts page from the left sidebar and click Add Account.
Fill in the details:
  • Name -- a label you will recognize (e.g. "Main Checking", "Visa Rewards")
  • Type -- choose from checking, savings, credit card, loan, investment, cash, cryptocurrency, money market, mortgage, or line of credit
  • Currency -- pick from 45+ supported currencies including major fiat currencies and crypto
  • Opening Balance -- the account balance at the time you start tracking
Click Save. Repeat for any other accounts you want to track.
Tip: For credit cards and loans, enter the balance as a negative number to represent money owed. You can also set a credit limit for credit card accounts.
2. Add Transactions
You have two options: import from your bank or add transactions by hand.
Import from your bank
Go to Import in the sidebar and upload a statement file. Budget supports CSV, OFX, and QIF formats. The importer auto-detects delimiters and number formats, and includes duplicate detection so you can safely re-import overlapping date ranges.
See Import for the full walkthrough including column mapping and dual-column amount handling.
Add manually
Go to Transactions, select an account, and click Add Transaction. Enter the date, description, amount, and optionally assign a category. You can also split a single transaction across multiple categories.
3. Set Up Categories
Go to the Categories page. You have two options:
  • Generate defaults -- click Create Default Categories and Budget will generate a full category tree based on the 50/30/20 budgeting rule (50% needs, 30% wants, 20% savings). If you provide your monthly income, budget amounts are pre-calculated for you.
  • Create your own -- click Add Category to build a custom hierarchy from scratch.
Categories are organized in a tree structure, so you can have top-level groups (like "Housing" or "Food") with specific sub-categories underneath.
Tip: You can always reorganize categories later. Transactions keep their assignments even if you move categories around.
4. Create a Budget
Go to the Budget page and set spending limits for each category. Choose a budget period (monthly is most common) and enter the amount you want to allocate to each category.
As transactions come in, Budget tracks your spending against these limits. You will see alerts on the dashboard when you are approaching or exceeding a budget.
5. Explore the Dashboard
The Dashboard is your financial command center. It shows 28+ customizable tiles organized into sections:
  • Hero tiles at the top -- net worth, monthly income, monthly expenses, net savings, and more
  • Charts -- income vs. expenses trends, spending by category, net worth history
  • Summary cards -- account balances, budget progress, upcoming bills, savings goals, debt payoff status
Click Customize Dashboard to show, hide, or rearrange tiles to match what matters most to you.
Note: Some tiles (like budget alerts and savings goals) only appear once you have set up the corresponding features.
What's Next
Now that the basics are in place, explore these features to get more out of Budget:
  • Rules -- Set up auto-categorization rules so imported transactions are categorized automatically
  • Bills -- Track recurring bills and get Nextcloud notifications before they are due
  • Income -- Monitor expected income sources and flag missed payments
  • Forecast -- See predicted future balances based on your spending history
  • Savings Goals -- Set financial targets and track your progress
  • Reports -- Generate year-over-year comparisons and spending breakdowns
  • Shared Expenses -- Split costs with housemates, partners, or friends
  • Password Protection -- Add an app-level password for extra security
  • Settings -- Customize currency, date formats, and other preferences