Documentation

Skrongle is a self-hosted learning app with lessons, quizzes, phone sessions and games, all driven by JSON course files.

Guides

  • Getting started: what the app is, the five ways to study (Sprint, Study, Play, Guide, AI tutoring) and when a lesson counts as passed.
  • How a course is built: a course folder, course.json, lesson files and which field switches on which feature, with examples from the Spanish course.
  • Building and generating courses: the editor, adding files, generating a course with AI, sharing a course, fixing validation errors.
  • Themes for learners and authors: wearing a theme, and the rules for writing themed material.
  • Host it yourself: run your own copy on a Raspberry Pi Zero 2 W, step by step. The technical version is Self-hosting.
  • FAQ — API keys, missing games, sharing, running your own copy.

Reference

  • Course format: every field and rule of course.json and lesson files. Give it to an LLM and it can write a course. Also as raw Markdown and a JSON Schema.
  • Features: what each part of the app does and which lesson fields it reads: Lessons, Quizzes, Guide, Sprint mode, Games, Map, Vocabulary, History, Themes, Subscriptions.
  • Theming: theme files and everything a course can carry for a theme: themed examples, exercises, questions, conversations and icons.
  • Progress across modes: the pass rule, and the API (and brief) for AI agents that teach the learner.
  • Languages (i18n): the app’s own text in the learner’s language: one i18n/<code>.yaml per language, the pickers, how code reads it, and how a course gets translated (a translated copy).
  • Pricing Skrongle AI: the AI Skrongle provides on its own key: what each plan includes, the list prices, the margin, and why one key with our own meter.
  • Self-hosting: install, configuration, backups, troubleshooting.
  • Self-hosting FAQ: help, updates, backups, going back a version, and one entry per startup error.
  • Data inventory: what is stored about a learner, where, why, what leaves the server and for how long. The draft privacy policy (served at /privacy) is written from it.

For LLMs

/llms.txt lists the pages an LLM needs to write a course. Every page here is also raw Markdown. Add .md to its address.

For developers

Working on the code? See Developer documentation: architecture, testing, QA, the security review, scalability and load testing.