CreditWatch is a local-first dashboard for tracking credit cards, their annual fees, and ongoing benefits. It helps you make sure you never miss a benefit and understand whether the value you extract from each card outweighs its cost.

• 📇 Manage an unlimited list of credit cards with account name, last four digits, annual fee, and fee due date.
• 🎁 Track monthly, quarterly, or annual benefits for each card, including their value, description, and expiration.
• ✅ Mark benefits as used to keep a running tally of realized value versus your annual fees.
• 📊 Gorgeous, card-based Vue 3 interface with at-a-glance progress bars for each credit card.
• 🗂️ SQLite persistence so your data lives alongside the app when run locally or inside Docker.
• 💾 Automated SMB backups with monthly retention plus one-click restores from the admin panel.

backend/        # FastAPI application, SQLModel models, and SQLite database utilities
frontend/       # Vue 3 + Vite single page application
backend/data/   # Persisted SQLite database files (ignored from git)

Two dedicated setup scripts are provided—one for the FastAPI backend and one for the Vue frontend.

./setup_backend.sh

The script will create (or reuse) a local virtual environment in .venv, install Python dependencies, and start uvicorn on http://127.0.0.1:8010. Override the host or port by exporting BACKEND_HOST or BACKEND_PORT before running the script.

./setup_frontend.sh

This script installs JavaScript dependencies, writes the required Vite environment variables, builds the production bundle, and serves it via vite preview on http://127.0.0.1:4173. Use FRONTEND_HOST, FRONTEND_PORT, BACKEND_URL, or BACKEND_PORT environment variables to customize the runtime configuration.

The Vue frontend is PWA-enabled via vite-plugin-pwa. When the preview or production build is served over HTTPS (or localhost), browsers expose an Install option so CreditWatch can run standalone with offline caching for static assets.

During development the service worker auto-updates. If you make frontend changes and notice stale assets, refresh the page to load the latest version.

If you prefer containers, the project ships with a ready-to-use Compose definition.

docker compose up --build

• The FastAPI backend is exposed on http://localhost:8010.
• The Vue.js frontend is served by Nginx on http://localhost:5173.
• SQLite data persists between runs via the backend/data bind mount.

Stop the stack with docker compose down.

The backend exposes a REST API under /api. The most important endpoints are:

FastAPI automatically exposes interactive docs at http://localhost:8010/docs.

The Backups card in the admin panel manages database resilience:

• Provide the SMB server, share, optional subfolder, username, and password to enable hourly backups.
• CreditWatch waits an hour after the most recent data change before copying the SQLite database to the share. Each month is stored as a single creditwatch-YYYY-MM.db snapshot so older months remain available.
• Uploading a *.db file restores that snapshot immediately and reinitialises the schema. This operation overwrites any unsaved changes, so keep a backup handy.

These features rely on the smbprotocol client library, which ships with the backend requirements.

1. Add a credit card with its fee details using the "Add a credit card" form.
2. Select a card and add benefits such as travel credits or dining offers, including their value and reset cadence.
3. When you use a benefit, hit Mark used—the dashboard will adjust the utilized total and net position.
4. Review the progress bars to see which cards are paying for themselves and which still need attention.

• The backend automatically creates the SQLite database on first run. Database files live in backend/data.
• Frontend API requests are relative to /api, which is proxied in development (Vite) and in production (Nginx) to the FastAPI service.
• Hot reloading is available on both the backend (uvicorn --reload) and frontend (npm run dev).

This project is provided for internal testing and evaluation purposes.