SERVE

Spending, Earnings, & Resources View Engine — a Django + React web application for processing and consolidating financial transaction data from multiple banks and credit cards.

Quick start

1. Follow the setup guide to configure your workstation.
2. cd backend && python manage.py runserver to start the API server.
3. cd frontend && pnpm dev to start the frontend.
4. Open http://localhost:5173 in your browser.

How to help

PRs welcome for bug fixes and improvements. See the setup guide for how to get your environment running.

What's in this repo?

Documentation

• SETUP: Instructions to get everything up and running.
• LICENSE

backend

The Django REST API, responsible for:

• User accounts and household management
• Bank, account type, and account configuration
• CSV transaction imports with automatic bank detection
• Duplicate prevention via SHA-256-based dedupe hashes on transaction data
• Label and category preservation across re-imports

Built with Django Ninja for fast, type-safe endpoints, backed by MySQL.

frontend

The React application, responsible for:

• Household and account management UI
• Transaction browsing and labeling
• CSV upload interface

Built with React + TypeScript + Vite.

scripts

Developer utilities, including git hooks that enforce linting on staged files and block direct commits to main.

Architecture

serve/
├── backend/
│   ├── config/               # Django settings and URL routing
│   ├── users/                # CustomUser and Household models
│   └── transactions/         # Core transaction logic, API, handlers
├── frontend/
│   └── src/                  # React + TypeScript application
├── requirements/             # Python dependencies
└── scripts/                  # Git hooks and dev tooling

License

Licensed under CC BY-NC 4.0. You are free to use, modify, and share this project with attribution, provided it is not used for commercial purposes.