oguzgelal / juken

Review App for WaniKani
https://juken.netlify.app
MIT License
28 stars 6 forks source link

Juken
Juken

Review App for WaniKani

Sail through your reviews without typing. Just recall, reveal and swipe.

IntroductionPlatformsContributorsFeedbackContact



Juken

Introduction

Juken is a minimalistic review app for WaniKani optimized for speed. It eliminates the need for typing; you just have to recall, reveal the answer and submit by swiping left or right.

Juken was inspired by the popular flashcard app Anki in the sense that it allows revealing the answers instead of having to typing it out, and it features Tinder-like swipe gestures to effectively submit your answers. Just login with your WaniKani Personal Access Token and start swiping.

User Interface

Cards are fairly simple; they show the Japanese characters and the question text under it. The characters are color coded in WaniKani color scheme; purple for vocabulary, pink for kanji and light blue for radicals. After you recall, simply use the Reveal button to reveal the answer. It's a press & hold interaction to avoid accidental touches. On the web (desktop), you can reveal the answer using the space bar as well. Once revealed, the answer will be displayed under the characters: if you got the answer right, swipe right, if you got it wrong, swipe left. On desktop (web), you can use the arrow keys instead of swiping. That's all there is to it.

Screen Shot 2020-05-17 at 7 27 03 PM

As for the review stats below the cards; the top and bottom rows show completed review and card data respectively. A "card" represents a question, every single question asked in a review session comes in a card, it's basically a review / review type pair. (ie. for one vocab or kanji review, there are two cards - reading and meaning, for one radical review there is one card - meaning).

The bars displays the percentage of the completed correct / incorrect reviews / cards respectively. A card is completed when you get it right, and a review is completed when you get all the cards for a review right. If you get a card wrong, it'll be requeued and asked again, and it won't be included in the percentage until you get it right. Same goes for reviews. Once you get a card / review right, it will be count as correct if you didn't submit an incorrect answer for it previously, otherwise, it'll be count as incorrect. (The number of incorrect answers you've submitted for a card / review isn't reflected on the bar - as it'll just count as one wrong answer - but it'll be submitted to WaniKani).

The X of Y displays show the number of items you have completed (X), and the number of items you have available in total (Y). The Y of the top bar shows how many reviews you have in that session, and the Y of the bottom bar shows how many cards you have in total (ie. how many questions you'll be answering). The X of the top bar is the number of reviews you have completed, and its superscript shows the number of half finished reviews, that is, the number of reviews that are not completed but has one completed part. It could also be thought as the number of reviews that'll lost if you close the app mid-session. The X at the bottom bar shows the number of cards you have completed.

Personal Access Token

To log in with your WaniKani account, you'll need to obtain a personal access token. Here's how you can get one:

  1. Login to https://wanikani.com
  2. Click on your avatar on the top right corner, select API Tokens under Settings from the dropdown
  3. Under Personal Access Tokens section, click Generate a new token button down below
  4. Write a descriptive text in the What is this token for? input (ie: "Juken")
  5. Check the following boxes:
    • Recommended: Check all the boxes. For now, Juken doesn't need all these permissions, however down the line I might add new features that needs some (or all) of them. For a smooth transition to newer versions, I recommend you to check all the boxes now.
    • Restricted: Check the one with the label reviews:create
  6. Click Generate Token
  7. You can log in with the code generated and listed under the Token column next to the item you've just created. Enjoy ☺

Platforms

Juken is a cross-platform application, available natively on mobile platforms and for the web. It's built with React Native, and uses react-native-web for web support. There are a few different ways you can use Juken, you can find some details and links below. Note that Web version receive updates / bug fixes more frequently and earlier than the native iOS and Android counterparts due to the review processes of the app stores.

iOS

Juken App Store

Android

Juken Google Play

Web

Juken Web

Juken is available on the web, and it is optimized for the desktop experience. You can do your reviews using only your keyboard; space to reveal the answer and arrow keys to submit instead of the swipe gestures (although gestures are still available for touch screen devices using the web app). Juken is also optimized for the mobile web. You can go to juken.io on your mobile browser and have a decent review experience (although native apps offers a much superior experience and are recommended).

Contributors ✨


Tiago Bento

📖 👀

Joy Alice Gu

📖 👀

Aku Mäkelä

📖 👀

Feature Requests

I am planning to maintain Juken and add in more features down the line. Needless to say, I'm open to feature requests. To see what's planned and get insights on the roadmap, you can check out the tickets under each milestone, tickets related to new features will have an enhancement tag. You can also head over to issues section and submit your own feature request.

Reporting Bugs

If you find a bug in Juken, reporting it would be much appreciated. You can head over to the open issues section and submit the issue from there. I'll try to fix bugs as quick as possible. Reporting bugs is easy, I made a crash screen that shows the error details (as shown below), so you can just take a screenshot of it and include it in your ticket.

Further Contact

If you like to contact me direcly, you can do so by sending an email to o.gelal77@gmail.com.

Mentions

Our preview images were created using 'Previewed' at https://previewed.app. Thanks Previewed!