halkyon/packages/halkyon_base_client/README.md
Tizian 「ティツィアーン」 af1de799f4
halkyon_base: a Serverpod module for sign-in, accounts and instance basics
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>
2026-10-19 14:29:28 +02:00

8 lines
408 B
Markdown

# halkyon_base_client
The client of [`halkyon_base`](../halkyon_base_server/README.md), generated by Serverpod:
what a Halkyon app calls to sign in, to manage its account, and to learn an instance's
basics, under `client.base` in the app's own client. Never edited by hand; run
`serverpod --no-analytics generate` in `halkyon_base_server` instead.
Under the GNU Affero General Public License 3.0 or later.