Lexi

Lexi is a Telegram-first vocabulary trainer with themed lessons, spaced repetition, pronunciation audio, quizzes, and a protected operations console.

The repository, package and production domain keep the historical mydictionary identifier so the rebrand does not break stored data, URLs or deployment automation.

Product scope

• Free starter packs for English, French, German, Japanese, Arabic, Chinese, Russian, and Spanish, plus the existing Vietnamese pack.
• Topic-based 10-word learning blocks, flashcards, written and multiple-choice tests, XP, streaks, and scheduled review.
• Curated meaning languages selected during onboarding, target-language spelling, Latin transcription, and text-to-speech pronunciation. Legacy packs without a curated pair keep an explicit Russian fallback.
• A five-step native Telegram onboarding saves each learner's language pair, goal, preferred format, and daily pace, then opens the first lesson directly.
• PostgreSQL multi-user storage with Alembic migrations and an explicit local-only SQLite mode.
• A server-rendered admin console for learner access, pilot D1/D7 retention, privacy-safe product analytics, credit operations, and audit history.
• Optional metered AI tutor, voice practice, and Telegram Stars billing. Each has an independent fail-closed rollout gate.
• Optional Telegram Mini App with five read-only learner views: profile, dictionary/tracked words, AI credits, languages, and settings. It uses signed Telegram initData, never creates learning or billing records on open, and delegates every action back to the existing bot flows.
• A separate browser dictionary at /dictionary/: seven reviewed starter packs (700 entries), bilingual local search, saved words, short written practice, explicit offline storage, standalone HTML download and saved-word CSV export. It opens without Telegram or a learner account. Words outside these packs can be sent to Yandex Translate by an explicitly labelled link. Local dictionary practice does not sync to Telegram learner progress.
• Verified local PostgreSQL backups, encrypted off-site replication tooling, retention controls, health monitoring, and a migration-aware OVH release contract.

Local development

Requirements:

• Python 3.12+
• PostgreSQL 16 for the full storage and admin path

Install the locked dependencies:

python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install --requirement requirements.lock

Keep secrets outside Git. The bot requires BOT_TOKEN; production also requires DATABASE_URL. SQLite is available only when ALLOW_SQLITE_DEV=true is set explicitly.

Access is fail-closed by default: BOT_ACCESS_MODE=allowlist admits only the Telegram IDs listed in ALLOWED_USER_ID or comma-separated ALLOWED_USER_IDS. Set one of those values for private local testing. Use BOT_ACCESS_MODE=public only as a deliberate public-access opt-in; pilot keeps self-registration separate from owner approval.

Start the Telegram polling process:

python bot.py

For admin-console setup and local commands, see docs/admin-console.md.

Validation

python -m unittest discover -s tests -v
python -m compileall -q .

GitHub Actions runs the complete suite against PostgreSQL 16, including migrations, isolated persistence, and concurrent credit reservations.

Repository map

Path	Purpose
bot.py	Telegram adapter and polling entry point
mydictionary/	Storage, catalog, learning, billing, privacy, AI, voice, and admin services
migrations/	Alembic database migrations
content/, words*.json	Versioned vocabulary sources and generated packs
ops/	Deployment, backup, monitoring, retention, and billing wrappers
tests/	Product, storage, operations, safety, and provider-contract tests
docs/product-foundation.md	Product principles and rollout boundary
docs/pilot-operations.md	Controlled cohort and D1/D7 measurement
docs/launch-readiness.md	Paid and voice release gates
docs/mirror-control-plane-v1.md	Mirror modes, quality analytics, and voice translation gates
docs/telegram-miniapp.md	Mini App security, product surface, configuration, and rollback contract
docs/offline-dictionary.md	Offline dictionary capabilities, local data, verification and update contract
docs/research/lexi-market-product-2026-09-06.md	Market evidence, adult/child positioning and staged product priorities
docs/runbooks/ovh-deployment.md	Canonical production deployment and rollback runbook
docs/runbooks/mac-mini-deployment.md	Historical Mac mini release contract
docs/runbooks/ovh-cloudflare-tunnel.md	Owner-gated OVH public-route recovery with token-file handling

Production currently runs in owner-controlled Docker services on OVH. The Mac mini and Render artifacts are historical and unsupported. The OVH application release and Cloudflare route deliberately use separate runbooks and gates.

Security and privacy

• Never commit Telegram, database, admin, backup, or provider credentials.
• Product analytics accept only allowlisted structured fields, never learner messages, answers, prompts, names, or contact details.
• AI usage records retain operational metadata rather than prompts or generated answers. Optional Mirror dialogue memory is disabled by default; when enabled under the current AI-processing consent, it stores at most 20 bounded turns for a short configured period. Voice transcripts are temporary and separately consented.
• Admin mutations require authentication and CSRF protection and are written to an audit log.
• Feature activation, migrations, external messages, payments, and production deployment require explicit operational approval.

License

The application source code is MIT-licensed; see LICENSE. The seven generated schema-v2 starter packs derive from the project's original content/basic_100.tsv matrix. Verify provenance and redistribution rights before republishing legacy or externally supplied vocabulary datasets.