A self-hosted personal CRM for tracking your relationships — contacts, interactions, reminders, gifts, debts, journal entries — with CardDAV sync, full-text search, and a React frontend. Built on the FastAPI full-stack template and deployed to a homelab via Docker Compose behind Traefik.
| Layer | What |
|---|---|
| Backend | FastAPI + SQLModel + Alembic, Python 3.12, uv |
| Database | PostgreSQL 18 |
| Search | Meilisearch (indexed via ARQ background tasks) |
| Queue | Redis + arq worker |
| CardDAV | Radicale mounted into the FastAPI app |
| Frontend | React + TanStack Router + TanStack Query + Vite + Bun + Tailwind + shadcn/ui |
| Auth | JWT access tokens, first-superuser bootstrap, password recovery via SMTP |
| E2E | Puppeteer (in e2e/) |
| Deploy | Docker Compose + Traefik; secrets via sops + age |
- Contacts — CRUD, favorites, archive, tagging, groups, list/detail views, inline editing
- Interactions — Log calls, texts, emails, in-person meetings, notes per interaction
- Reminders — Scheduled reminders with date/time, per-contact linking
- Tags & Groups — Organize contacts, many-to-many relationships
- Journal — Freeform personal journaling with entries
- Gifts — Track gifts given/received per contact
- Debts — "I owe them" / "they owe me" tracking per contact
- Notes — Freeform notes attached to a contact
- Users & Admin — Signup, login, logout, password recovery, superuser-gated user management
- Dashboard — Stats, "losing touch" suggestions, recent interactions
These routes are registered and tested at the API level, but have no frontend pages. Either build the UI or remove them when you decide the feature is out of scope.
addresses,pets,relationships,contact_fields— read-only rendering on the contact detail page, no add/edit UIcustom_fields— per-contact arbitrary fieldslife_events— birthdays, anniversaries, major eventsimport_export— bulk contact import/export (CSV / vCard)webhooks— outbound webhook registrations
The Copier template's items module has been removed from the API router (the model + Alembic table remain for now — drop with a dedicated migration if/when desired).
Captured against the seeded fake-data fixture (
just seed-fixed), 1440×900.
Dashboard — stats, "losing touch" queue, and recent interactions:
Contacts list — last-contact decay indicator, tags, and company/role:
Contact detail — timeline of interactions, notes, gifts, and life events with a relationships sidebar:
Interactions feed grouped by date with channel badges:
Reminders:
Calendar — birthdays and life-event anniversaries surfaced per day:
Journal — freeform daily entries with optional mood:
Tags:
backend/ FastAPI app, Alembic migrations, pytest suite, Radicale CardDAV bridge
frontend/ React app (Vite), generated OpenAPI client in src/client/
e2e/ Puppeteer end-to-end tests (bun run e2e/*.test.ts)
docs/ architecture.md, DB_SCHEMA.md, HANDOFF.md
compose.yml Homelab production stack (kindrednet networks, Meilisearch, Redis, ARQ worker)
compose.dev.yml Dev-against-homelab overlay (bind-mounted source, --reload, frontend dev server)
.env Runtime env vars (gitignored)
.env.sops Production secrets, encrypted with sops + age
Production (homelab default):
docker compose up -d --buildDev against the homelab (bind-mounted source, live reload):
docker compose -f compose.dev.yml up -d --buildFirst boot runs Alembic migrations and creates the admin user from FIRST_SUPERUSER / FIRST_SUPERUSER_PASSWORD in .env.
Backend (inside the running stack):
docker compose exec backend bash scripts/tests-start.shEnd-to-end (Puppeteer, requires a running stack):
bun install
bun run e2eProduction secrets live in .env.sops, encrypted with age. Rotate with:
EDITOR=vim sops .env.sopsNote: because
.env.sopsuses the.sopsextension (not a format sops auto-detects), you may need--input-type dotenv --output-type dotenv, or temporarily copy to a*.envpath for editing.
After rotating FIRST_SUPERUSER_PASSWORD, the change only takes effect on fresh deployments. Existing homelab databases retain the old superuser password until you manually update it (or delete and recreate the user via initial_data.py).
This project was scaffolded from the FastAPI full-stack template via Copier. The backend/README.md and frontend/README.md files are still mostly upstream template content — treat them as reference, not project-specific docs.







