halkyon/apps/learn/halkyon_learn_server
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Tizian 「ティツィアーン」 af1dbee509
build: Melos, a Dart check and every path for the single repository
- Melos 8.9 as the root's dev dependency, with scripts across the
  workspace (analyze, test:dart, test:flutter, generate, check) and its
  filters (--diff, --include-dependents); cli_util overridden to 0.5.2
  for it, since Learn's flutter_launcher_icons asks for 0.4 and uses only
  its logger, unchanged in 0.5.
- tool/check.dart in place of tool/check.sh: packages, formatting of our
  own files, analysis, the tools' tests, then every package's tests
  through Melos (--changed-since=<commit> for only what changed and what
  depends on it). tool/pre-push is the hook: the signature check, then
  the checks. CI generates every server's code and runs the same check.
- The images build from the root with a workspace narrowed to what they
  need (tool/workspace_only.sh); compose, the deploy's migration test,
  the snap, the release script, the editor's launch files and Learn's
  asset tools (run from apps/learn) follow the new layout.
- The project's source is named as project-halkyon/halkyon (source link,
  snap, F-Droid listing, release uploads); the AGPL packages carry the
  licence's own text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
2026-10-22 18:11:04 +02:00
..
bin chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
config chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
data chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
dictionaries chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
lib build: Melos, a Dart check and every path for the single repository 2026-10-22 18:11:04 +02:00
migrations chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
test chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
.gitignore chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
analysis_options.yaml build: one workspace for every app and the packages they share 2026-10-22 18:11:03 +02:00
CHANGELOG.md chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
dart_test.yaml chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
Dockerfile build: Melos, a Dart check and every path for the single repository 2026-10-22 18:11:04 +02:00
LICENSE chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00
pubspec.yaml build: one workspace for every app and the packages they share 2026-10-22 18:11:03 +02:00
README.md chore: Halkyon Learn moves into apps/learn 2026-10-22 18:11:02 +02:00

halkyon_learn_server

This is the starting point for your Serverpod server.

Start your server by running:

cd halkyon_learn
serverpod start

When you are finished, you can shut down the running server with Q.

Dictionaries

The dictionaries people look words up in (JMdict, …) are reference data the server holds for everyone. They come as dictionary files, which halkyon_learn_curator makes from the sources' downloads (its README says how). At every start, and every hour at seven past, the server loads the files in its dictionaries folder that changed since they were last loaded (by their SHA-256): in the background, a source at a time, and all at once, so searches meanwhile still find the old entries. A file it can't read is logged and left out. A dictionary whose file is gone is unloaded, once every file in the folder could be read (the curator removes the files of languages an instance no longer keeps). DICTIONARIES_DIR names another folder.

EDRDG's licence asks a server showing its dictionaries to update them at least once a month:

  • An instance keeps them current by itself: the dictionaries service in deploy/compose.yaml (the curator, in a container of its own) downloads EDRDG's files of the day once its files are a week old, converts them, and replaces them in a volume the server reads (curate update, the curator's README); the server takes them up within the hour. To supply files yourself instead, remove the service and mount deploy/dictionaries/ into the server (compose.yaml says how), and update them monthly.
  • Development: dart run halkyon_learn_curator:curate update --into ../halkyon_learn_server/dictionaries in the curator's folder (about a minute); the server takes them up within the hour.

JMdict in English, with the JLPT levels and Tatoeba's example sentences, is about 20 MB gzipped and takes the server half a minute to load (219,000 entries). KANJIDIC2 in English, with the JLPT levels of the kanji and the kana, is a dictionary of characters beside it (kanjidic-en.jsonl.gz, 0.7 MB, 12,800 entries): the app's Kanji & kana tab. Their licences (CC BY-SA 4.0; CC BY 2.0 FR for the sentences; CC BY for the JLPT lists) ask for attribution: the app lists the credits each file carries.

Licence

Copyright (C) 2026 The Halkyon Learn contributors

Licensed under the Server Side Public License, version 1 (SSPL-1.0); the full text is in LICENSE.