Skip to content

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Subscribed

A self-hosted household subscription tracker. Household members can track any subscription: a name, an optional category and notes, a currency, an amount and a billing cadence, with a full price history (backdated, corrected and upcoming prices), per-currency monthly and yearly totals, and English and Danish screens. A subscription can be paused and resumed: a paused subscription stays in the overview but is left out of the monthly and yearly totals, and its price history is untouched. Underneath: Keycloak sign-in through a backend-for-frontend (HttpOnly cookie, no tokens in the browser), app-owned household membership, event-sourced Household and subscription streams on PostgreSQL (Marten), health/config validation, tests and a single-container Docker deployment.

Path Contents
backend/ .NET 11 modular monolith (API/BFF, admin CLI, tests)
frontend/ Angular SPA (built to frontend/dist/subscribed/browser, served by the backend)
deploy/ Dockerfile, production compose (external PostgreSQL/Keycloak), provisioning template, dev Keycloak
scripts/integration-check.sh image + ephemeral PostgreSQL end-to-end check
docs/subscription-catalog.md how the known-services catalog is maintained and verified
docs/dev-environment.md pinned development tools and container rebuild instructions

Run with Docker

Follow the Docker setup guide to choose an image, configure PostgreSQL and Keycloak, create secrets, run migrations and grant your first household member. The application container includes both frontend and backend; you do not need Node or .NET on the Docker host. PostgreSQL, Keycloak and an HTTPS reverse proxy must be provided separately.

Quick start (development)

Prerequisites: .NET SDK 11.0.100, Node 24.22.2, PostgreSQL 18 (devcontainer db service), optionally Docker for the dev Keycloak.

export SUBSCRIBED_TEST_DB='Host=localhost;Port=5432;Username=…;Password=…;Database=…'   # CREATEDB+CREATEROLE role
dotnet build backend/Subscribed.slnx -c Release -warnaserror
dotnet test backend/Subscribed.slnx -c Release --no-build
dotnet format backend/Subscribed.slnx --verify-no-changes

Running the app locally, the admin CLI and the configuration keys are described in backend/README.md; production deployment in deploy/README.md.

Container releases

Push a version tag such as v0.1.0 to run CI, publish the Docker image to ghcr.io/kimipsen/subscribed, and create a GitHub Release with SPDX SBOMs, the source commit SHA, image SHA-256 digest and downloadable checksums. See the release instructions for permissions, verification and digest-pinned deployment. Images have version tags (both v0.1.0 and 0.1.0) and full-SHA tags; stable releases also update ghcr.io/kimipsen/subscribed:latest. Prereleases leave latest unchanged.

Security model in one paragraph

The browser only talks to the same-origin backend. The backend is a confidential OIDC client (authorization code + PKCE, response_mode=query) and keeps a session cookie (__Host-subscribed, HttpOnly, Secure, SameSite=Lax, 2 h idle / 12 h absolute) holding only issuer, subject, display name and sign-in time. Being signed in does not grant access: every API request checks (issuer, subject) against the household's event-sourced member list, so revocation is immediate. API requests, session checks and logout need X-CSRF: 1; there is no CORS. Origin, when present on an unsafe request, must match the configured public origin. The database application role can only append events (no UPDATE/DELETE on the event table), which readiness verifies on every probe.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages