Skip to content
voidrotPublic

About

Self hosted chore and behavior system

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

chorecast

Self hosted chore and behavior system.

  • server/ — Go API server (chi + Huma, SQLite) that also serves the web admin
  • web/ — Vue 3 + Naive UI + Tailwind admin SPA, embedded into the server binary
  • android/ — Kotlin + Jetpack Compose app for parents, kids and shared family tablets

See docs/architecture.md for the stack and auth decisions.

Development

Everything is driven by mise:

mise install          # Go, Node, pnpm, JDK, Android cmdline-tools, sqlc, goose, linters, lefthook
mise run setup        # deps + git hooks
mise run dev          # server on :8080, Vite on :5173
mise run gen          # sqlc + OpenAPI spec + TS client
mise run ci           # lint, test, build (server + web)

mise run android:sdk  # one-time: SDK platform + build tools (accept licenses)
mise run build:android

Commits follow Conventional Commits; releases are cut by release-please.

Self-hosting

docker compose -f deploy/compose.yaml up -d

Guides for running Chorecast at home:

  • Install: Docker Compose, image variants, the data volume and environment variables.
  • First run: the setup link, pairing kids' phones and shared tablets, installing the Android app.
  • Single sign-on: OIDC setup with Authentik or PocketID.
  • Backups and restore: scheduled backups, chorecast backup and chorecast restore.
  • Upgrading: image tags, migrations and the pre-1.0 schema policy.

About

Self hosted chore and behavior system

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages