Milestone 3: launch (20261008.05)
Backup and restore: restore from Settings (any backup in the folder, or an
uploaded file) or from the command line with scripts/restore.sh. Each restore
checks the file first, saves a copy of the current data so it can be undone,
and keeps the person restoring signed in. Backups are now single
self-contained files. Drilled end to end: last night's backup brings
everything back exactly, including onto an empty new machine.
Speed: a phone's first load is 147 KB compressed (target 150). The ideas box,
account menu and sign-in screens load on demand, a small built-in toast
replaces sonner, the Inter font is trimmed to the characters used, and files
and API answers are served compressed. Every screen's data comes back in
under 100 ms with 50,000 transactions (server/bench).
Accessibility: no WCAG 2.2 AA issues on any screen in either theme. Darker
status text colors, 44 px touch targets on phones, reduced motion honoured,
and focus returns after dialogs close.
Also: an in-app guide ("How Spendlight works"), OFX/QFX/QBO import, and tags
on individual parts of a split purchase.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
21
README.md
21
README.md
@@ -4,13 +4,14 @@ A private, self-hosted household budgeting app: import bank and card
|
||||
statements, categorize in a tap, budget by month, and keep an eye on
|
||||
subscriptions. Runs as a single container on arm64 or amd64.
|
||||
|
||||
Status: milestones 0 to 2 are built (foundation, money in, the full picture).
|
||||
Milestone 3, launch hardening, is next.
|
||||
Status: milestones 0 to 3 are built: foundation, money in, the full picture,
|
||||
and launch (accessibility, speed, backup and restore, an in-app guide).
|
||||
|
||||
## What it does
|
||||
|
||||
- **Import** CSV statements from Bank of America, Discover, Chase, Capital One,
|
||||
Citi and Apple Card, plus any other bank through a one-time column mapper.
|
||||
OFX, QFX and QBO files (Quicken, Money, Web Connect) work too.
|
||||
Duplicates are skipped, card payments and transfers are paired, and any
|
||||
import can be undone.
|
||||
- **Review** new transactions with one-tap category suggestions that learn
|
||||
@@ -38,6 +39,22 @@ scripts/deploy.sh # builds a versioned image and starts it
|
||||
HTTPS comes from your own reverse proxy (see `deploy/nginx.conf.example`).
|
||||
The API is documented at `/api/docs` on a running instance.
|
||||
|
||||
## Backups and restoring
|
||||
|
||||
Every night at 02:30 (`BACKUP_TIME`) a complete copy of the database lands in
|
||||
the backups folder, plus one before every upgrade and every restore. Point any
|
||||
backup tool at that folder to keep copies off the server.
|
||||
|
||||
- **Everyday restore:** Settings → Backups → Restore, as an admin. Spendlight
|
||||
checks the file, saves a "before restore" copy of the current data, and
|
||||
switches over. Restoring that copy undoes it. "Restore from a file" takes a
|
||||
backup from somewhere else, such as another machine.
|
||||
- **When the app can't be used:** put the backup file in the backups folder and run
|
||||
`scripts/restore.sh spendlight-nightly-20261007-023000.db`. It stops the app,
|
||||
restores, and starts it again.
|
||||
- **Moving to a new machine:** copy the data folder, or start with an empty one
|
||||
and run the restore script before the first sign-in.
|
||||
|
||||
## Developing
|
||||
|
||||
The host only needs Docker; Node 24 runs in a container.
|
||||
|
||||
Reference in New Issue
Block a user