RevTK Developers Hub

From RevTK

Welcome to the RevTK developers hub!

What is Reviewing the Kanji?

Reviewing the Kanji (abbreviated "RevTK") is a web application to learn and review the japanese characters. The site was originally created to support the kanji study method "Remembering the Kanji", from James W. Heisig.

The main features are a study area where learners can share kanji mnemonics, and a flahscard review area which uses the principle of spaced repetition to promote long term memory of the kanji.

Reviewing the Kanji became an open source project in January 2010. Fabrice's main motivations to make the website/webapp into open source are detailed in the January 11, 2010 announcement.

The website's codebase is free software licensed under AGPLv3. It is written in php and uses git for version control.

Project Overview Goals History Roadmap Changelog: what was done Getting Started Development environment Version control with Git Clone and configure the project Cookbook (tips and tricks) Contribute Coding guidelines A Git workflow Project Structure Core: a lightweight MVC framework Core Documentation: a mini application documenting the framework CoreJs: front end components library Reviewing The Kanji: the website Tools: Juicer, YUI Compressor Project Materials References Data files Licenses

Github repository git clone git://github.com/fabd/RevTK.git Or download ZIP/TAR archive Project Discussion Please subscribe to the topic for project news. If not done yet, create your account (main site + forum!). Project Roadmap This is our current todo list. We are looking for a "tracking" solution.

Meta: Project Organisation

To avoid spamming the existing community forum, I propose to use the Talk Pages to discuss the open source project and its organization. See WikiMedia:Talk Page formatting.

Here are some topics to discuss:

• Iterations: how to iterate quickly, and deploy a "develop" branch on the test.koohii.com subdomain for other contributors and users to give feedback.

• Git workflow: should probably create a page with conventions for tagging the stable releases, naming topic branches, template for commit messages, ..