halkyon-days/halkyon
Watch
1
0
Fork
You've already forked halkyon
 0
Code Issues Pull requests Projects Releases 37 Packages Wiki Activity Actions
No description
1,092 commits 1 branch 38 tags 51 MiB
  • Dart 78.6%
  • PLpgSQL 19.3%
  • Kotlin 1.1%
  • C++ 0.4%
  • CMake 0.2%
  • Other 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Tizian 「ティツィアーン」 d09625d43e
 refactor(content,core,app,editor,learn): Learn's content in pure Dart, for its agent 
ADR 0044's D49 (amended in building it): what reads and seals Learn's
content moves out of the Flutter packages, so Learn's agent, which runs
without Flutter, shares it rather than repeating the privacy rules.

packages/halkyon_content (new, pure Dart) takes from halkyon_app the
envelope and its cipher, SealedFile, UnlockedAccountKeys, shared
spaces' gateway with SharedKeys and KeyPins, FileCache and
FileServerGateway, with their fakes and tests; halkyon_app exports it,
so no app changes. Its rich_text.dart takes RichContent from
halkyon_editor, which exports it. newAccountKeys makes an agent's key
pair. halkyon_core takes DelayedDeletions and gains SyncRequests, what a
synced gateway asks of the sync, which SyncService implements.

apps/learn/halkyon_learn_core (new, pure Dart) takes Learn's privacy,
sync, payloads and the models, codecs, gateways and repositories of
studysets, cards, notes, tags and feedback, with what they reach of
files, learning paths, citations and study options; the app imports them
from there. A subject's icon, colour and name stay in the app
(SubjectLook); what only the app shows (progress, exam coverage, the
card browser, deletions' waits) stays too. Nothing changes for people
using the apps.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
2026-11-11 22:08:16 +01:00
.forgejo/workflows build(ci,deploy)!: the runner at home in a nightly window, deploys by hand (ADR 0039, D6, D13, D16) 2026-11-08 19:59:40 +01:00
.vscode build: Melos, a Dart check and every path for the single repository 2026-10-22 18:11:04 +02:00
apps refactor(content,core,app,editor,learn): Learn's content in pure Dart, for its agent 2026-11-11 22:08:16 +01:00
deploy feat(base,app,learn,todo,train,meditate): agent accounts with tokens 2026-11-11 19:56:13 +01:00
docs/adr refactor(content,core,app,editor,learn): Learn's content in pure Dart, for its agent 2026-11-11 22:08:16 +01:00
packages refactor(content,core,app,editor,learn): Learn's content in pure Dart, for its agent 2026-11-11 22:08:16 +01:00
snap build(learn): the snap's icon on the white tile too (ADR 0031, D10) 2026-11-10 14:22:57 +01:00
test feat(deploy): halkyon.li's first start, its .env made on the host (ADR 0039, D21) 2026-11-08 22:07:22 +01:00
third_party refactor(learn): the editor's general parts move to halkyon_editor (ADR 0033, D37) 2026-11-07 21:49:48 +01:00
tool feat(learn,train,todo,meditate): the icons on a white tile again, coloured by the system's theme on Android and iOS (ADR 0031, D9, D10) 2026-11-10 14:22:49 +01:00
.dockerignore build(editor): halkyon_editor joins the workspace (ADR 0033, D37) 2026-11-07 21:49:47 +01:00
.gitignore feat(deploy): Jellyfin at home, published through WireGuard (ADR 0032) 2026-10-30 23:17:57 +01:00
AGENTS.md refactor(content,core,app,editor,learn): Learn's content in pure Dart, for its agent 2026-11-11 22:08:16 +01:00
analysis_options.yaml build: Android's built-in Kotlin, the three plugins applying KGP themselves patched in third_party/ 2026-11-04 09:32:13 +01:00
CLAUDE.md chore: scaffold the Serverpod 4 build 2026-09-24 15:32:29 +02:00
CONTRIBUTING.md docs: one repository for every app and shared package (ADR 0015) 2026-10-22 18:11:04 +02:00
LICENSE.md refactor(learn): the editor's general parts move to halkyon_editor (ADR 0033, D37) 2026-11-07 21:49:48 +01:00
pubspec.lock perf: sync fork streams what a device lacks, and writes in shared spaces 2026-11-11 14:13:26 +01:00
pubspec.yaml refactor(content,core,app,editor,learn): Learn's content in pure Dart, for its agent 2026-11-11 22:08:16 +01:00
README.md refactor(learn): the editor's general parts move to halkyon_editor (ADR 0033, D37) 2026-11-07 21:49:48 +01:00

README.md

Halkyon

Halkyon's apps and the packages they share, in one repository. Each app is a Flutter app for Linux, Windows, macOS, Android and iOS with a Serverpod server of its own, offline-first, and anyone may run an instance of it: the apps, the servers and everything needed to host an instance are published.

App What it is Where
Halkyon Learn Creating, sharing and studying study material, flashcards scheduled with FSRS apps/learn/, at learn.halkyon.eu
Halkyon Todo To-dos; for now a shell on the shared packages: sign-in, instances, the account apps/todo/
Halkyon Train Running, cycling and rowing (ADR 0030); for now a shell on the shared packages apps/train/

Halkyon Meditate is to follow.

Layout

  • apps/<app>/: each app's server, generated client and Flutter app.
  • packages/: what the apps share, taken by path: halkyon_ui (the look: theme, bundled Noto Sans, layout, shared widgets), halkyon_app (instances, signing in, each person's data and its sync), halkyon_base (what every server has, as a Serverpod module with its generated client halkyon_base_client: signing in, the account and its deletion, the pruning, the instance's basics), halkyon_editor (rich text: the editor, its view and the document they keep), halkyon_core (low-level primitives) and halkyon_interop (contracts between apps).
  • deploy/: what runs an instance (Docker Compose: Caddy, the server, PostgreSQL), learn.halkyon.eu's today.
  • tool/: the checks, the pre-push hook and the release scripts. docs/adr/: the decisions and their reasons.

One pub workspace holds every package: one pubspec.lock, one version of each dependency. Melos runs scripts across them.

Getting started

  • Flutter v3.47.8, the version CI uses (FLUTTER_VERSION in .forgejo/workflows/ci.yaml), with each platform you build for set up by Flutter's own guides; what an app needs beyond that is in its README.
  • The Serverpod CLI v4.0.4: dart install serverpod_cli@4.0.4. Pass --no-analytics to every call; otherwise it reports the commands run to Serverpod.
  • A C++ compiler, for flutter test too: a dependency of Learn's compiles MeCab as it builds.
flutter pub get                               # every package of the workspace
dart run melos list                           # the packages
ln -s ../../tool/pre-push .git/hooks/pre-push # the checks before every push
dart run tool/check.dart                      # format, analysis, every package's tests

dart run tool/check.dart --changed-since=origin/main tests only what changed since main and what depends on it; dart run melos run test:flutter --scope=<package> one package's Flutter tests. Each server's tests start an embedded PostgreSQL (no Docker) and need test passwords in the server's git-ignored config/passwords.yaml (the module's README and each app's say which). How the code is organised and the rules it follows are in AGENTS.md and each app's own.

Licences

The servers and the server module are under the Server Side Public License 1.0, the apps, the client packages and the other shared packages under the GNU Affero General Public License 3.0 or later. LICENSE.md says which covers what, CONTRIBUTING.md how to contribute.