How jerwingubat/budget-app works
BudgetFlow is a browser-based personal-finance app. A signed-in user enters through the protected app shell, then uses finance pages to record transactions and manage budgets, cards, and debts; the dashboard and reports present summaries. Pages use shared Firestore hooks for live data, while debt sharing and receipt scanning provide distinct workflows. The README also documents export/import, categories, and installable offline use. Some paths and features are documented or indexed but not fully sampled, so uncertain internal links are omitted.
Main entry points: App.jsx Protected app routes · useFirestore.js Collection hooks · firestore.js Firestore service · Transactions.jsx Transactions
Components 23
App shell
- Protected app routes
src/App.jsx - Navigation layout
src/components/Layout.jsx - Google sign-in
src/pages/Login.jsx
Finance features
- Dashboard
src/pages/Dashboard.jsx - Transactions
src/pages/Transactions.jsx - Budgets
src/pages/Budgets.jsx - Credit cards
src/pages/CreditCards.jsx - Debt tracker
src/pages/Debts.jsx - Reports
src/pages/Reports.jsx - Settings and backup
src/pages/Settings.jsx
Identity and data
- Auth context
src/contexts/AuthContext.jsx - Firebase client
src/firebase.js - Collection hooks
src/hooks/useFirestore.js - Firestore service
src/services/firestore.js - Firestore database
Specialized workflows
- Debt sharing dialog
src/components/ShareDebtsModal.jsx - Receipt scan dialog
src/components/ScanReceiptModal.jsx - Receipt scan flow
src/hooks/useReceiptScan.js - OCR service
src/services/ocrService.js - Receipt parser
src/utils/receiptParser.js
Browser platform
- Browser
- Offline service worker
public/sw.js
Other components
- User
Connections 34
- User → Protected app routes: opens
src/App.jsx - Protected app routes → Auth context: checks identity
src/App.jsx - Protected app routes → Navigation layout: wraps protected pages
src/App.jsx - Protected app routes → Google sign-in: routes to
src/App.jsx - Protected app routes → Dashboard: routes to
src/App.jsx - Protected app routes → Transactions: routes to
src/App.jsx - Protected app routes → Budgets: routes to
src/App.jsx - Protected app routes → Credit cards: routes to
src/App.jsx - Protected app routes → Debt tracker: routes to
src/App.jsx - Protected app routes → Reports: routes to
src/App.jsx - Protected app routes → Settings and backup: routes to
src/App.jsx - Google sign-in → Auth context: signs in
src/pages/Login.jsx - Auth context → Firebase client: uses auth client
src/contexts/AuthContext.jsx - Dashboard → Collection hooks: reads live data
src/pages/Dashboard.jsx - Transactions → Collection hooks: manages entries
src/pages/Transactions.jsx - Budgets → Collection hooks: manages budgets
src/pages/Budgets.jsx - Credit cards → Collection hooks: manages card data
src/pages/CreditCards.jsx - Debt tracker → Collection hooks: manages debt data
src/pages/Debts.jsx - Reports → Collection hooks: reads report data
src/pages/Reports.jsx - Settings and backup → Collection hooks: manages categories
src/pages/Settings.jsx - Settings and backup → Firestore service: exports and imports
src/pages/Settings.jsx - Collection hooks → Firestore service: subscribes and writes
src/hooks/useFirestore.js - Collection hooks → Firebase client: reads settings
src/hooks/useFirestore.js - Firestore service → Firebase client: uses database client
src/services/firestore.js - Firestore service → Firestore database: queries and updates
src/services/firestore.js - Debt tracker → Debt sharing dialog: opens sharing
src/pages/Debts.jsx - Debt sharing dialog → Firestore service: creates or revokes shares
src/components/ShareDebtsModal.jsx - Collection hooks → Firestore service: loads shared debts
src/hooks/useFirestore.js - Transactions → Receipt scan dialog: offers receipt scan
src/pages/Transactions.jsx - Receipt scan dialog → Receipt scan flow: starts scan flow
src/components/ScanReceiptModal.jsx - Receipt scan flow → OCR service: prepares and reads image
src/hooks/useReceiptScan.js - Receipt scan flow → Receipt parser: parses receipt text
src/hooks/useReceiptScan.js - User → Browser: uses
README.md - Browser → Offline service worker: registers for offline use