Expense Trackers Technical Documentation
Complete guide for configuring, installing, deploying, and utilizing Expense Trackers with Laravel 12, Vue 3, Inertia, PWA Offline Sync, and Stripe Subscriptions.
1. Introduction
Expense Trackers Pro is an enterprise-grade personal wealth and expense management system architected on Laravel 12, Vue 3, and Tailwind CSS. It delivers a comprehensive ecosystem for tracking multi-account liquid balances, categorized incomes and expenses, internal transfers, visual budgets, and scheduled recurring bills.
With an integrated Progressive Web App (PWA) offline engine powered by browser IndexedDB, users can record financial entries even with zero internet connectivity. As soon as the network returns, the system automatically synchronizes pending transactions via background reconcilers.
2. Core Features
Multi-user Authentication & OTP
Queued email OTP verification, 30-day auto-grant free trials, and admin activation controls.
Multi-Account Balances
Cash, Bank, Mobile Money, and Credit Cards with real-time balance calculations on every transaction.
Categorized Incomes & Expenses
Custom color-coded user categories for granular financial classification and drill-down analysis.
Internal Account Transfers
Zero-fee internal funds transfers between accounts with atomic database transactions.
Category Budget Limits
Budget caps with customizable date ranges and visual threshold warnings (safe, warning, exceeded).
Automated Recurring Transactions
Daily, weekly, monthly, and yearly recurring schedules processed via php artisan app:process.
Dynamic Subscription Billing
Stripe Checkout session webhooks + Manual bKash/Nagad/Bank slip approvals with USD-to-BDT conversion.
Offline-First IndexedDB Sync
Create accounts and log transactions completely offline; seamless background syncing upon reconnect.
3. Server Requirements
Verify that your hosting environment meets the following specifications:
storage/ and bootstrap/cache/ directories are writable by your webserver user (e.g., chmod -R 775 storage bootstrap/cache).
4. Installation Guide (Laravel 12)
1 Clone / Extract Codebase
Place the application source code in your web document root:
git clone https://github.com/your-username/codecan-myTracker.git
cd codecan-myTracker
2 Install Composer Dependencies
composer install --optimize-autoloader --no-dev
3 Configure Environment (.env)
Copy the sample file and generate a fresh cryptographic application key:
cp .env.example .env
php artisan key:generate
4 Run Migrations & Seed Demo Data
php artisan migrate --seed
5 Symlink Public Storage
php artisan storage:link
6 Compile Frontend Assets (Vite)
npm install
npm run build
5. Seeding & Demo Access
The seeders generate default administrators, subscription tiers (Monthly, Annual, Lifetime), currency exchange settings, and sample transactions.
💡 Upon your first login, navigate to Profile Settings → Security to immediately change your password.
6. Environment Configuration
Configure the following key parameters inside your root .env file:
Stripe Payment Gateway Keys
STRIPE_KEY=pk_test_your_stripe_publishable_key
STRIPE_SECRET=sk_test_your_stripe_secret_key
STRIPE_WEBHOOK_SECRET=whsec_your_stripe_webhook_signing_secret
Mail & Queue Configuration (OTP)
QUEUE_CONNECTION=database
MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=your_username
MAIL_PASSWORD=your_password
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS="no-reply@expensetrackers.com"
MAIL_FROM_NAME="${APP_NAME}"
7. Background Queue Worker (OTP Delivery)
All OTP registration pins and email notifications are dispatched asynchronously to prevent UI freezing. The queue worker must be kept running:
php artisan queue:work --sleep=3 --tries=3 --max-time=3600
8. Task Scheduler & Recurring Crons
Recurring income and expenses (subscriptions, monthly rents, salaries) require the Laravel scheduler to execute the custom command php artisan app:process every minute.
Add the following cron entry to your server's crontab (crontab -e):
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1
To manually test recurring transactions execution at any time:
php artisan app:process
9. Offline-First Architecture & PWA
Expense Trackers employs an innovative offline-first architecture utilizing:
- Service Worker (sw.js): Pre-caches application shells, stylesheets, and JavaScript bundles for instant offline boots.
- IndexedDB Storage: Accounts, categories, and offline transactions are persisted client-side in the browser.
- Reconciliation Sync API: When network connectivity resumes, pending offline entries are posted to
/api/offline/sync, returning server IDs and refreshed balances seamlessly.
10. Database Schema Reference
| Table | Primary Purpose & Key Attributes |
|---|---|
| users | id, name, email, phone, role (admin/user), plan_id, trial_ends_at, subscription_ends_at |
| subscription_plans | id, name, slug, price, currency, billing_cycle, features, is_popular, is_active |
| accounts | id, user_id, name, balance (decimal 15,2), account_type, is_active |
| categories | id, user_id, name, type (income/expense), color, icon |
| transactions | id, user_id, account_id, category_id, amount, type, transaction_date, notes |
| transfers | id, user_id, from_account_id, to_account_id, amount, transfer_date |
| budgets | id, user_id, category_id, amount, start_date, end_date |
| recurring_transactions | id, user_id, account_id, category_id, amount, type, frequency, next_run_date |
11. FAQ & Troubleshooting
Q: Why did I not receive the registration OTP pin?
Ensure your queue daemon is active (php artisan queue:work) and your SMTP mail parameters are correctly configured in .env.
Q: How do internal transfers impact income or expense reports?
Transfers represent internal liquidity movement between your own accounts (e.g. Bank to Cash). They do not alter your net profit or loss metrics.
Q: How do I change the default currency?
Users can switch their preferred currency symbol ($, €, £, ৳, ₹) directly from their Profile Settings screen without modifying any backend code.
12. Support & Changelog
Customer Support: Dedicated support is provided for verified customers. Inquire directly via CodeCanyon customer portal.
Changelog v2.0 (Laravel 12): Dynamic pricing engine, dark & light themes, PWA offline sync, manual & Stripe dual payment reconciliation, and granular budget management.