halkyon/apps/todo/README.md

23 lines
1.3 KiB
Markdown
Raw Normal View History

# Halkyon Todo
To-dos, as a Halkyon app: for now a shell on the shared packages. People choose an
feat(base,app)!: GitHub signs nobody in any more (ADR 0020, D36) Every account signs in with SimpleLogin or a password now, so GitHub goes from the module, the shared app package, Learn and Todo, ahead of ADR 0017's GITHUB_SIGN_IN_ENDS. - halkyon_base: no `gitHubSignIn` endpoint, GitHub identity provider or GitHub refusals; no `githubClientId`/`githubClientSecret`, no `GITHUB_SIGN_IN_ENDS` and no `forgetGitHubAccounts`; the register loses `account-with-github`. `SignInWays.gitHub`, the basics' `gitHubClientId` and `gitHubSignInEnds`, and `PasswordRefusal`'s `signInAgain` and `noAddress` go. A first password takes a code mailed to the person's own address; an account without one sets none (`wrongCredentials`). - Learn's server: `instance.info()` without `gitHubClientId`, the pruning without GitHub, and `minimumAppBuild` 24, as builds up to 23 (v0.20.0) require `SignInWays.gitHub`: the server deploys with the release of build 24. - halkyon_app: no GitHub button or problems on the start screen, no password offered after a GitHub sign-in, and `ServerpodAuthGateway` without the browser half only GitHub used (`(client, base:)`). The account section offers a first password only to an account with an address. `LoopbackWebAuth` and the apps' schemes stay, SimpleLogin's ways back. - Learn's Profile lists no GitHub; the texts go (English, German). - Serverpod's `serverpod_auth_idp_github_account` stays, as its migrations make it; a row goes with its account, and ADR 0020's D36 gives operators the SQL to delete those left. - deploy/: compose.yaml and .env.example without GitHub. The READMEs, AGENTS.md files and ADR 0017 amended. BREAKING CHANGE: builds up to 23 can't read the instance's answers about an account's ways in; minimumAppBuild is 24. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
2026-10-25 12:52:52 +01:00
instance, sign in (with SimpleLogin or a password), switch between the accounts on
their devices, sign out and delete their account; the home is empty until Todo's first
model.
| Package | What it is |
|---|---|
| [`halkyon_todo_server`](halkyon_todo_server/) | The server: Serverpod with the `halkyon_base` module |
| [`halkyon_todo_client`](halkyon_todo_client/) | Its client, generated by Serverpod |
| [`halkyon_todo_flutter`](halkyon_todo_flutter/) | The app, on `halkyon_app` and `halkyon_ui` (Android, iOS, Linux, macOS, Windows) |
Run it with `serverpod start` in `halkyon_todo_server`, which starts the server (and its
embedded PostgreSQL) and the app; or the app alone against an instance with
`flutter run --dart-define=SERVER_URL=https://…/` in `halkyon_todo_flutter`. Tests:
`dart run melos run test:dart --scope=halkyon_todo_server` and
`dart run melos run test:flutter --scope=halkyon_todo_flutter` at the repository's
root, or `dart run tool/check.dart` for everything.
The app's icon is [Lucide](https://lucide.dev)'s `list-todo` (ISC licence, ADR 0031),
drawn by the repository's `tool/app_icons.py`. Licences: the server under the SSPL, the client and the app under
the AGPL ([`LICENSE.md`](../../LICENSE.md)).