How bronco84/budget-planner-vue works
Project Type and Purpose
• This is a monolithic, full-stack web application built on Laravel (PHP) with an Inertia.js + Vue 3 frontend.
• Purpose: personal finance and budgeting tool that integrates with Plaid and other bank-feed strategies, manages budgets, transactions (including recurring), payoff plans, chat support, file attachments, and reporting.
Architectural Overview
• Pattern: MVC (Models, Views, Controllers) on the backend; component-based SPA on the frontend via Inertia.
• Single codebase: Laravel handles HTTP, CLI commands, background jobs, database migrations, and business logic (app/Services). Vue components render pages, talk to Laravel controllers over Inertia or AJAX fetch.
a. Client Layer
• Web Browser
• Inertia.js Adapter & Vue 3 SPA (resources/js)
b. Application Layer (Laravel)
• HTTP Controllers (app/Http/Controllers & subfolders)
• CLI/Console Commands (app/Console/Commands)
• Services & Business Logic (app/Services, Enums, Policies)
• Eloquent Models & Repositories (app/Models)
• Middleware (app/Http/Middleware)
• Request Validation (app/Http/Requests)
• Event Broadcasting / Notifications (EventServiceProvider)
c. Data Layer
• Relational Database (MySQL/PostgreSQL) via Eloquent
• Migrations & Seeders (database/migrations, database/seeders)
• Cache (Redis or file cache)
• Queue System (Redis/Database queue, jobs in database/jobs)
d. External Integrations
• Plaid API (app/Services/BankFeed/PlaidImportStrategy, PlaidController)
• Airtable Import Strategy (app/Services/BankFeed/AirtableImportStrategy)
• File Storage (local or S3 via config/filesystems)
• Optional third-party services: Mail (Mailgun, SMTP), Broadcasting (Pusher, Redis)
e. CLI & Scheduled Jobs
• Recurring transaction analysis
• Plaid account diagnosis/fixes
• Recurring transactions
• Laravel Scheduler (defined in app/Console/Kernel)
Relationships & Data Flows
• Browser → Inertia → Laravel HTTP Controller → Service Layer → Eloquent → Database
• Controllers ←→ Vue Components (page data & JSON) via Inertia endpoints
• CLI Commands / Scheduler → Service Layer → DB / External APIs
• Queue Workers consume jobs → Service Layer → DB / Notifications
• External API calls:
• PlaidImportStrategy ←→ Plaid API
• AirtableImportStrategy ←→ Airtable API
• File Uploads: Browser → Controller(FileController) → Storage → DB (FileAttachment)