Kanji Koohii is a web application designed to help Japanese language learners remember the kanji. http://kanji.koohii.com
The mobile view
The desktop view
Create an "issue" in the Issues tab. New issue.
Let's talk on Gitter. The "feedback" room is intended for user feedback and testing. The "development" room is where we can talk about the code (that way testers can opt out of notifications from the development chat). Note there are Android and iOS clients with push notification support. Desktop client also shows the recent repository activity.
Have a look at Milestones. I use them to group issues in categories of interests such as front-end performance, UX improvements, etc.
If you'd like to contribute something not on the issue board, reach me on Gitter and we'll see how it fits into the site, then break it down into smaller tasks and create issue(s) as required.
Development requires a typical LAMP setup (Apache/MySQL/Php) with a shell. The setup is currently tested on Ubuntu. The build script should work with very little changes on OS X. For Windows, you'll probably want a virtual machine with a linux distro so you can use grep, npm etc.
- First Time Setup for setting up the repository and database
- Build for basic info about dev/test environments
- Docs has links to the MVC framework documentation (Symfony).
- HTTPS will be enabled soon (hopefully April 2017)
- Refactoring legacy php templating to Vuejs client-side components
- Vocabulary features : "favorite" example words in Study pages, create a vocab deck and review with SRS
- Improve Study pages : better moderation & voting system, stroke order animations, better search
- Improve the API for third party clients like Kanji Ryokucha
For more details see Open Source on the wiki.
The source code is licensed as AGPLv3 (see the LICENSE file), with exception of the following third party licenses.
Note: the license of each particular project can be found on their respective websites. This list is not exhaustive and may be updated from time to time. The main purpose is to give an overview of things Kanji Koohii is built on.
- Symfony 1.4 (main framework)
- Zend Framework (bits and pieces)
- UTF-8 to Code Point Array Converter in PHP by Henri Sivonen
- Vue.js
- YUI2 (legacy Javascript being phased out)
- FontAwesome icons (free)
Choice of license. The GNU AFFERO GENERAL PUBLIC LICENSE v3 is chosen to encourage cooperation, particularly in the case of network distributed software. Specifically: "public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version."
Original assets. The website design and identity as "Kanji Koohii", as well as original artwork (such as the logo) are Copyright 2017 Fabrice Denis and intended for use exclusively at the kanji.koohii.com domain.
RTK Index and Keywords: The AGPL license does not cover permission granted explicitly to Fabrice Denis and for use on Kanji Koohii (previously "Reviewing the Kanji") by James W. Heisig, author of "Remembering the Kanji", to use the RTK index and keywords. The database provided with the repository includes RTK index and keywords for development purposes only, and the permission to use them does not extend to derived works based on this public repository and its data files.
Font Awesome 5 Pro: as a backer of FontAwesome 5 Pro, I may use FA 5 Pro resources in the future. The license is for my own use on my projects including Kanji Koohii, and does not extend to any derivative uses of this software (see FAQ).