Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iwatakeshi/kanji

A Kanji dictionary for the web.
https://github.com/iwatakeshi/kanji

Last synced: 6 days ago
JSON representation

A Kanji dictionary for the web.

Awesome Lists containing this project

README

        

kanji
=====

A Kanji dictionary for the web.

The available grades are from first through sixth.

Note: Only part of the first has been added and will continue to expand along the way.

The benefits of using this:

* modular - easily create a dictionary by grade (follows a similar pattern as moment.js).
* examples with ruby
* easy to use API
* findByRomaji (available as a static method to narrow down results)
* findByMeaning (available as a static method to narrow down results)
* findByOnyomi (note all on-yomi must be Katakana)
* findByKunYomi (note all kun-yomi must be Hiragana)
* works with node.js
* locale support (search kanji in your locale)

###Usage

In browser

```html




var k = kanji();
k.findByMeaning('round');
/* output
{
character: "円",
example: Array[5],
kunyomi: Array[1],
meaning: Array[3],
onyomi: Array[1],
romaji: "en"
}
*/

```

In node.js

Note: This project is not yet available on npmjs.org.

```js
var kanji = require('kanji.js');//subject to change
console.log(kanji().grades()); //return the entire dictionary
```

###Instructions

This project uses Node.js & Express.

```bash
#install node modules
npm install

#start project
npm start

```

1. Go to localhost:3000
2. Open Developer console
3. Play with kanji!

To develop, the files will be located under `./public/javascripts`

If you don't want to use or have node.js then go the located directory and import them
to your index.html file.

Docs will be updated once kanji has been completed

**Start project and find Kanji by meaning:**

![](https://github.com/iwatakeshi/kanji/blob/master/gifs/kanji-npm.gif)

**Change locale and find Kanji by meaning:**

![](https://github.com/iwatakeshi/kanji/blob/master/gifs/kanji-locale.gif)

**Find Kanji by Kun-yomi**

![](https://github.com/iwatakeshi/kanji/blob/master/gifs/kanji-kunyomi.gif)