This repository has been archived on 2026-10-23. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
halkyon_shared/README.md
Tizian 「ティツィアーン」 96f2d14618
halkyon_app: data locations as precise as a country or a state
An operator's DATA_LOCATION and BACKUP_LOCATION may name a subdivision
(ISO 3166-2, US-CA, DE-BY) besides the EU or a country. The app adds
"(EU)" to a member country and the country to a subdivision ("Germany
(EU)", "California, United States", "Bavaria, Germany (EU)"), in
English and German, and shows the most specific flag there is: a
subdivision's own where the flag package has one, else its country's.
Subdivision names come from Unicode CLDR 48.2 (tool/subdivision_names.py),
bundled with their licence, which the app registers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
2026-10-19 18:50:26 +02:00

35 lines
1.9 KiB
Markdown

# halkyon_shared
Shared Dart packages across Halkyon apps, a pub workspace:
- [`halkyon_ui`](packages/halkyon_ui): Halkyon's look, the theme, fonts, layout
and shared widgets (Flutter).
- [`halkyon_app`](packages/halkyon_app): what every app is built around, on an
instance's `halkyon_base`: the instances a device keeps accounts on, signing
in, each person's data opened and closed, and syncing it (Flutter).
- [`halkyon_base`](packages/halkyon_base_server/README.md): what every Halkyon
server has, as a Serverpod module (`halkyon_base_server` and its generated
client `halkyon_base_client`): signing in, the account and its deletion, the
pruning, and the instance's basics.
- [`halkyon_core`](packages/halkyon_core): low-level primitives (pure Dart),
`SerialQueue` and `CoalescingRunner` among them.
- [`halkyon_interop`](packages/halkyon_interop): cross-app contracts (pure Dart).
Dart 3.13 and Flutter 3.47, with LeanCode's lints (`leancode_lint`), configured
once in `analysis_options.yaml` here, which every package includes but the
generated `halkyon_base_client`: its analyzer plugin only reaches packages of a
workspace from the root. Run
`flutter pub get` and `dart analyze --fatal-infos` here, and each package's
tests in its folder (`dart test`, or `flutter test` for `halkyon_ui`, its
example and `halkyon_app`). `halkyon_base_server`'s tests start Serverpod's embedded PostgreSQL by
themselves and need a git-ignored `config/passwords.yaml` (see its README).
`tool/subdivision_names.py` writes `halkyon_app`'s names of subdivisions from a
release of Unicode CLDR (`python3 -I tool/subdivision_names.py release-48-2`).
Licences: the server package `halkyon_base_server` is under the Server Side
Public License 1.0, as the Halkyon servers are; every other package under the
GNU Affero General Public License 3.0 or later.
Apps take a package by git, pinned to a signed commit; see
[`halkyon_ui`'s README](packages/halkyon_ui/README.md).