Skip to content

Japanese immersion browser extension

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
license_mit.txt
Notifications You must be signed in to change notification settings

BlueGreenMagick/yomikiri

Repository files navigation

Yomikiri

Yomikiri is a Japanese immersion learning tool. As you read Japanese text and encounter words you don't know, look up the meaning and add the word to Anki flashcards.

Yomikiri is available for Chrome, Firefox, and iOS.

Available in the Chrome Web Store Get the add-on for Firefox Download on the App Store

Features

  • Shift + Hover over a word to view definition. It recognizes word boundaries within sentence.

  • Search words and sentences in popup.

  • Add word to Anki. You can preview and edit the note before adding.
    If Anki is not running, notes are stored and automatically added later. You don't have to keep Anki running in the background all the time.

  • Customizable Anki note template.

  • View sentence translation.

  • View relevant grammar with a link to Tofugu.

Building from source

Please note that we do not support building the project on Windows. You may want to use WSL to build the project. The build system has only been tested on MacOS 14 (ARM) however, and may not quite work on Linux.

NodeJS, pnpm, Rust & cargo, wasm-pack must be installed.

Run the following commands

# Downloads and builds JMDict and UniDic dictionary files
pnpm run construct:web
# install node dependencies
pnpm install
pnpm generate-licenses

To build for ios as well, add ios target to rust: rustup target add aarch64-apple-ios, rustup target add aarch64-apple-ios-sim, and run pnpm run construct:all.

Chrome

Run pnpm dev:chrome or pnpm build:chrome.

In Chrome, go to chrome://extensions/, toggle developer mode. Press 'Load unpacked' and open /main/build/chrome.

Firefox

Run pnpm dev:firefox or pnpm build:firefox.

In Firefox, type about:debugging in the url bar to open debugging menu. Switch to 'This Firefox' tab. Press 'Load Temporary Add-on...' and open /main/build/firefox/manifest.json.

Ios

Open /safari/Yomikiri.xcodeproj on XCode.