Thank you for reading this and helping improve the project! We all have the power to make Japanese learning more accessible, achievable and free.
Here are some important resources:
- Ankiweb documentation is great for both general Anki information and use of the web app
- Anki-Android's Database Structure, the best explanation of the Anki database structure
- Genanki documenation, the library used to generate our decks
Improvements for the code, card templates and japanese notes are all welcome.
Please see our Guiding Principles to help inform your changes.
- Python 3+
- Node.js 12+
To install python dependencies:
pip install -r requirements.txt
# Or pip3 install -r requirements.txtTo install Node.js dependencies:
npm installTo build Anki apkg files from the CSVs run the script scripts/generate-decks.py.
To update screenshots of the templates run the command npm run generate-screenshots.
The CSV schema contains the following fields
expression- The text of how the vocablurary would appear in a JLPT testreading- The reading of the text, usually expressed in hiragana or katakanameaning- The english meaning of the expressiontags- Metadata for the note that could be used by various Anki apps for advanced customisation. The existing data are relics from the previous deck that the project was sourced from.guid- The “Globally Unique Identifier” used by Anki to keep a stable reference of notes. For new entries we can ignore adding this and the project should autogenerate a new guid. Changing this field would result in losing existing progress or history within your Anki app.
Please send a GitHub Pull Request to open-anki-jlpt-decks and follow the Pull Request template.
-
Python code is linted and formatted with black.
After installing python dependencies, run from your terminal
black scriptsto format your code. -
JavaScript code is linted and formatted with prettier-standard.
After installing the node.js dependencies, run from your terminal
npm run formatto format your code.
Thanks!