23 lines
1.3 KiB
Markdown
23 lines
1.3 KiB
Markdown
|
# Halkyon Todo
|
||
|
|
|
||
|
|
To-dos, as a Halkyon app: for now a shell on the shared packages. People choose an
|
||
|
|
instance, sign in (without an account, with GitHub or with a code by mail), 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-checks` (ISC licence), drawn by
|
||
|
|
`tool/app_icons.py`. Licences: the server under the SSPL, the client and the app under
|
||
|
|
the AGPL ([`LICENSE.md`](../../LICENSE.md)).
|