# Japanese DB

Japanese DB is a utility for generating a Japanese dictionary SQLite database from open-source materials. Some resources (e.g., JMdict, JMnedict) are constantly updated. Therefore, this utility is suitable to automate the process of creating your Japanese database, and keep it up to date.

This repo also contains the [typescript type definitions](https://github.com/echamudi/japanese-toolkit/blob/master/packages/japanese-db/src/types/japanesedb.ts) for each row in the database. The types which can be imported in your typescript code or javascript through JSDoc.  

---

<p align="center">
  <a href="https://github.com/echamudi/japanese-toolkit/"><img src="https://raw.githubusercontent.com/echamudi/japanese-toolkit/master/images/japanese-toolkit.svg" alt="Japanese Toolkit Logo" width="160" height="128"></a>
  <br><br>
  <p  align="center">
This package is part of <a href="https://github.com/echamudi/japanese-toolkit/">Japanese Toolkit JS</a> suite.</p>
</p>

---

## Usage

1. Download required materials
    - Download `JMdict_e.gz` from http://www.edrdg.org/jmdict/edict_doc.html.
    - Download `JMnedict.xml.gz` from https://www.edrdg.org/enamdict/enamdict_doc.html.
    - Download `kanjidic2.xml.gz` from http://www.edrdg.org/wiki/index.php/KANJIDIC_Project.
    - Download `ka_data.csv` from https://github.com/echamudi/kanji-data-media/raw/master/language-data/ka_data.csv

1. Extract all the files and create folder structure as follow:
    ```
    myJpProject/
    ├── sourceFolder/
    │   ├── JMdict_e
    │   ├── JMnedict.xml
    │   ├── kanjidic2.xml
    │   └── ka_data.csv
    └── destinationFolder/
        └── (empty)
    ```

    The file names must be the same as above.

1. Open `myJpProject` folder in terminal.

1. Run following commands

    ```sh
    npm install japanese-db -g
    japanese-db sqlite -s ./sourceFolder -d ./destinationFolder
    ```

1. If it runs successfully, you'll get the result as `japanese.db` inside `destinationFolder` folder.

## Copyright Notices

If you are using the generated database in your project, you'll need to mention the following copyright notices & licenses.

JMdict, JMnedict, and KANJIDIC License:

> Copyright (C) 2017 The Electronic Dictionary Research and Development Group. Creative Commons Attribution-ShareAlike Licence (V3.0)

Kanji Alive Licesnse:

> Copyright Harumi Hibino Lory & Arno Bosse (Creative Common Attribution International 4.0 license)

Additional licenses for KANJIDIC:

> Jack HALPERN: The SKIP codes. Creative Commons Attribution-ShareAlike 4.0 International
> 
> Christian WITTERN and Koichi YASUOKA: The Pinyin information.
> 
> Urs APP: the Four Corner codes and the Morohashi information.
> 
> Mark SPAHN and Wolfgang HADAMITZKY: the kanji descriptors from their dictionary.
> 
> Charles MULLER: the Korean readings.
> 
> Joseph DE ROO: the De Roo codes.

Other notices from [kanji](https://github.com/echamudi/kanji) module:

> JLPT Study by Peter van der Woude https://jlptstudy.net
>
> Jonathan Waller JLPT Kanji List http://www.tanos.co.uk/jlpt/
>
> 日本漢字能力検定級別漢字表 https://www.kanken.or.jp/kanken/outline/degree.html
>
> KanjiVG by Ulrich Apel https://github.com/KanjiVG/kanjivg
>
> Kanjium by Uros Ozvatic https://github.com/mifunetoshiro/kanjium

If you feel helped by this free japanese-db converter tool, I would appreciate if you can add the following notice:

> The database in this app/project is genereted by using japanese-db tool by Ezzat Chamudi. (https://github.com/echamudi/japanese-db)

## Development

### Testing
```sh
npm link .
npm test
```

## Acknowledgment

The generated database file contains data from following sources.

- JMdict https://www.edrdg.org/jmdict/edict_doc.html
- JMnedict http://www.edrdg.org/enamdict/enamdict_doc.html
- KANJIDIC Project http://www.edrdg.org/wiki/index.php/KANJIDIC_Project
- Wanikani Audio https://github.com/tofugu/japanese-vocabulary-pronunciation-audio
- KanjiVG https://github.com/KanjiVG/kanjivg
- KanjiAlive https://kanjialive.com/credits/
- Kanji https://github.com/echamudi/kanji

## License

Copyright © 2020 [Ezzat Chamudi](https://github.com/echamudi)

Japanese DB code is licensed under [MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/). Images, logos, docs, and articles in this project are released under [CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/legalcode).

Libraries, dependencies, and tools used in this project are tied with their licenses.