Kanjidex is a simple chrome extension for looking up kanji characters and searching for words/phrases in Japanese. It uses the unofficial Jisho API and KanjiAlive API for fetching data.
You can see the extension on the chrome webstore following this link: https://chrome.google.com/webstore/detail/kanjidex/jhongcfphlabkimfoamdbffjgifglifk
This project was bootstrapped with Create React App.
You will need both Node.js and npm installed as well as a Chrome or Chromium browser for loading the extension. You will also need to get the KanjiAlive API key and replace the variables in src/helpers/getKanji.js and src/helpers/getEnglish.js with the given key.
Getting started is really easy. First, download the repository:
git clone https://github.com/hisekai/kanjidex.git
then install the npm modules:
npm install
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Don't forget to load unpacked the extension's dist folder on your Chrome or Chromium "extensions" page while ensuring the developer mode is enabled.
- unofficial-jisho-api - Awesome scraper for Jisho.org
- Kanji alive - Kanji Alive API for additional kanji information like radical animations and examples with audio
- dmak - draw me a kanji was used for adding more control to the kanji stroke animation
- tippyjs - used for tooltips
- nihongo - used for parsing Japanese characters
- bulma - CSS framework of choice
- react feather icons - icon set used in this project
- react kawaii - cute vector illustrations used for enhancing the UI^^
This project is licensed under the MIT License.