FireTracker / README.md
smlflg's picture
Initial public upload from Projekte/FireTracker
f91bd05 verified
|
Raw History Blame Contribute Delete
2.07 kB
# FireTracker
FIRE calculator with an ADHS-friendly flow: enter 3 numbers, see when you could be financially free.
FireTracker is a local-first single-user dashboard for tracking assets, FIRE progress, and simple what-if scenarios. No cloud account, no auth, no external bank connection required.
## Status
MVP shipped.
- 17 unit tests passing for the FIRE math core.
- 3 Playwright E2E flows exist for setup, dashboard, and asset creation.
- `fi_date` edge case fixed.
- Historical asset charts are future scope.
## What works
- Setup wizard — 3 fields, then straight to the dashboard.
- Dashboard — FI%, FI date, savings rate, 30-year projection, assets grouped by type.
- Assets CRUD — create, edit via htmx inline update, delete.
- Scenario API — “what if I save X more?” with `diff_years`.
- CSV import — simple German bank CSV parsing with semicolon delimiter and comma decimal support.
- JSON export — profile, assets, and snapshots as backup.
- Settings — FIRE parameters such as SWR, return, inflation, and target retirement age.
- Demo seed — sample profile with 5 assets.
## Run locally
```bash
cd ~/Projekte/FireTracker
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
uvicorn main:app --reload --port 8050
```
Open:
```text
http://localhost:8050
```
First start redirects automatically to `/setup`.
Optional demo data:
```bash
python seed.py
```
## Tests
```bash
# Unit tests, no server needed
pytest test_fire_math.py -q
# E2E tests, requires running server + Playwright browser install
playwright install chromium
pytest tests/test_e2e.py -v
```
## Stack
- FastAPI
- SQLAlchemy
- SQLite
- Jinja2
- htmx
- Tailwind CSS
- Chart.js
- pytest
- Playwright
## Scope
This is a personal/local MVP, not a hosted SaaS product.
Not included by default:
- multi-user accounts
- authentication
- cloud sync
- automatic bank API integration
- investment advice
## License
MIT License. See `LICENSE`.
## Disclaimer
FireTracker is a planning and visualization tool. It is not financial advice.