Summary

Hanabira.org is a free, open-source, self-hostable Japanese language learning platform targeting JLPT N5-N1 preparation. It provides tools for text parsing, grammar explanation, vocabulary SRS flashcards, and YouTube immersion to enhance learning. Korean content is planned for future integration.

How It Works

Built with NextJS 14, Tailwind CSS, shadcn, MongoDB, Express, and Flask, containerized via Docker. It integrates features like a text parser for tokenization, a grammar explainer, a graph visualizing word relations, spaced repetition system (SRS) flashcards with audio, and YouTube video integration for immersion. Kanji learning tools, such as mnemonics and interactive practice, are currently in development.

Quick Start & Requirements

Installation is facilitated via Docker Compose. The primary command is docker-compose up after cloning the repository (git clone https://github.com/tristcoil/hanabira.org.git). A clean VirtualBox Linux Ubuntu VM is recommended. Non-default prerequisites include Docker. Optional API keys for DEEPL, OpenAI, and Google Analytics can be configured. Note that Docker images are large (several GB each), unoptimized, and run under the root user. Audio files are not included in the repository.

Highlighted Details

• Easy self-hosting with a straightforward 3-command process using Docker.
• Aims to cover JLPT N5-N1 levels with dedicated learning tools.
• Features include YouTube Immersion, Text Parser, Grammar Explanations, Vocabulary SRS Cards, and a Word Relations Graph.
• Kanji learning modules are under active development.

Maintenance & Community

Development occurs in a private upstream repository; the public repo contains individual releases. A Discord server is available for community interaction ("Hanabira Discord").

Licensing & Compatibility

The core hanabira.org code is released under the MIT License. In-house created content is licensed under Creative Commons. External data sources have varied licenses, including the EDRDG Licence (potentially restrictive for commercial use) for KANJIDIC2/RADKFILE/KRADFILE, and CC BY-SA 4.0 for JMDICT. Code is provided "as is" without warranty; commercial use may be impacted by EDRDG restrictions.

Limitations & Caveats

The project is in a "very early Alpha stage" and is described as "full of bugs." Docker images are large, unoptimized, and run as root. Audio files are missing from the repository. Development is primarily private, with the public repo only reflecting releases. Database schema changes may occur, potentially requiring data resets.