Yochimu means prophetic dream in Japanese. The purpose of this tool is to let you read comfortably any kind of text, by reviewing and learning its vocabulary using an in-context approach with sentences using an SRS solutions like Anki.
What Yochimu does is, given a file with text in Japanese, it returns a list of words from that text along with their definitions, translations and example sentences, to let you create decks.
The plan would be to build our own SRS in the near future.
Requirements are Node.js and npm installed. I'm using yarn for managing dependencies but you can use whatever system you want. Some technical knowledge is required as well.
- Clone the repo.
- Run
yarn installornpm install. - Run
yarn devornpm run devfrom the root of your project. - The site should be ready on
http://localhost:3000
TEXT="私はペンです。" node index.js from the server folder. Right now, the system expectes input to be provided through environment variables, but the plan is to also add a RESTful API layer.
You can run tests with npm test.
By appending a search query string param, it's possible to trigger instant translations. E.g.: https://yochimu.now.sh/?search=神様が大好き.
This parser is built using Node.js with Express for the backend, and the frontend with Next.js and React. Everything is tested using with Jest.
cheerio is used to scrape content from non-JSON sources inside the parser.
This parser is using Kuromoji library to tokenise Japanese text.
Given this is a work in progress, as of version 0.1.0, we haven't decided yet which dictionary and translator to use.
頑張ってください！