Skip to content

fabd/kanji-koohii

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
doc
 
 
 
 
src
 
 
 
 
 
 
 
 

Kanji Koohii

Kanji Koohii is a web application designed to help Japanese language learners remember the kanji. https://kanji.koohii.com


The mobile view



The desktop view

Bugs & Feature Requests

Bugs reports and feature requests are welcome, please create a New issue in the Issues tab.

Contributing

In general pull requests for small fixes/typos are welcome.

For substantial changes it's probably a good idea to let me know in advance so I can tell you if I'm interested to merge and also give you useful information.

Keep in mind I started the website all the way back in the August 2005, so there are challenges that come with maintaining the site for such a long time. It was a barebones php4 site for the first year. It was later refactored to Symfony MVC. Today Koohii still runs with Symfony 1 in the backend, but the frontend can take advantage of ViteJs, Vue 3 and Tailwind CSS.

Development

Installation is fairly simple with Docker CE. The MySQL (Mariadb) container includes a sample database with a selection of the top-voted kanji stories. See Installation and Database guides.

For any questions related to the codebase, you may be able to reach me on discord.

LICENSE

License: AGPL v3

The source code is licensed as AGPLv3 (see the LICENSE file), with exception of the following third party licenses.

Acknowledgments

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.

Copyright Notices

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).