Tizian 「ティツィアーン」
af1de799f4
What every Halkyon server has, taken from Halkyon Learn's: anonymous, GitHub and email-code sign-in with their endpoints, an account's ways in and its deletion, the pruning of abandoned anonymous people, of sign-up attempts and of expired codes, and the instance's basics (the sign-in ways offered, the source link, the minimum app build, where people's data and its backups are). Endpoints sit under the nickname `base`. A host configures it in one place before its pod starts: its name for the mails, its source link, its minimum build, and hooks that delete its own data with a person. The tables keep Learn's names, columns and indexes, so a host moving onto the module migrates nothing but version rows. Server package under the SSPL, client under the AGPL, as Learn's are. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
28 lines
1.5 KiB
Markdown
28 lines
1.5 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_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).
|
|
- [`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` and its
|
|
example). `halkyon_base_server`'s tests start Serverpod's embedded PostgreSQL by
|
|
themselves and need a git-ignored `config/passwords.yaml` (see its README).
|
|
|
|
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).
|