Inkō

Inkō is a vocabulary learning app built around active recall across multiple channels: writing, typing, and listening. It now also supports importing Anki decks with field mapping, browsing shared community decks, and submitting curated decks back to a moderated public library.

What Users Can Do

• Create and manage vocabulary decks
• Import .apkg, .colpkg, CSV, TSV, and pasted exports with explicit field mapping
• Preserve imported pronunciation/audio URLs, including embedded Anki sound media
• Start with seeded starter content
• Practice from the dashboard into guided review flows
• Train production rather than passive recognition
• Browse community decks before importing them
• Submit imported or user-edited decks to the community moderation queue
• Review your own submission statuses from a dedicated submissions page
• Use local magic-link auth, or enable social sign-in when configured

For the product direction and learning model, see docs/prd.md.

App Routes

• /login
• /community
• /community/decks/:slug
• /community/submissions
• /community/moderation
• /dashboard
• /word-bank
• /imports/anki
• /practice/:deckId
• /settings

Quick Start

1. Install dependencies:

bun install

2. Copy local environment files:

cp apps/api/.env.example apps/api/.env
cp apps/web/.env.example apps/web/.env

3. Start PostgreSQL and run migrations:

bun run db:migrate

If you also want local object storage for imported audio and cached TTS:

docker compose up -d garage

4. Start the app:

bun run dev

5. Optionally seed starter data by inserting rows directly into PostgreSQL or by adding a dedicated seed script.

Local Auth

• With MAIL_PROVIDER=log, the login token is returned locally for development and can be pasted into the login form.
• With MAIL_PROVIDER=resend, magic links are sent by email.
• Google and GitHub sign-in are supported when their provider credentials and frontend flags are configured.

Documentation

The README is intentionally product- and usage-focused. Technical and implementation details live in the docs:

• docs/architecture.md: monorepo shape and request flow
• docs/frontend.md: web app structure and frontend commands
• docs/backend.md: API, auth, and backend env details
• docs/deployment.md: production deployment setup
• docs/prd.md: product requirements and UX intent
• docs/practice-queue-design.md: practice queue architecture

Common Commands

• bun run dev
• bun run test
• bun run lint
• bun run build