62 lines
2.6 KiB
Markdown
62 lines
2.6 KiB
Markdown
# Hirameki SRS
|
|
|
|
A simple and effective **Spaced Repetition System (SRS) app** for learning Japanese kanji and vocabulary from your WaniKani account. This app is built with Flutter and uses the official WaniKani API to sync your unlocked items.
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
This app is designed to be a lightweight and focused tool for reinforcing your WaniKani lessons on the go.
|
|
|
|
- **Kanji & Vocabulary Quizzes**: Separate quiz sessions for both Kanji and Vocabulary items.
|
|
- **Multiple Quiz Modes**: Test your knowledge in different ways:
|
|
- **Kanji/Vocab → English**: Guess the English meaning.
|
|
- **English → Kanji/Vocab**: Recall the Japanese characters from the English meaning.
|
|
- **Kanji Reading**: Practice the **On'yomi** and **Kun'yomi** for kanji.
|
|
- **Vocabulary Listening**: A special mode to test your listening comprehension by playing the audio and having you choose the meaning.
|
|
- **SRS-Based Learning**: Questions are prioritized based on their SRS level, helping you focus on items that need the most practice.
|
|
- **Browse Your Deck**: A dedicated screen to browse all your unlocked Kanji and Vocabulary.
|
|
- **Paginated by Level**: Items in the browse screen are grouped by their WaniKani level and organized into swipeable pages.
|
|
- **Quick Item Details**: Tap on a Kanji in the browse screen to see its readings, meanings, and level in a quick-view popup.
|
|
- **Offline Access**: Once your decks are downloaded, you can quiz yourself anywhere, anytime.
|
|
- **Simple & Clean UI**: A dark-themed, minimalist interface that keeps you focused on learning.
|
|
|
|
---
|
|
|
|
## Getting Started
|
|
|
|
Getting the app up and running is simple.
|
|
|
|
### 1. Installation
|
|
|
|
Clone the repository and install the dependencies:
|
|
|
|
```bash
|
|
git clone https://github.com/your-username/wanikani-kanji-srs.git
|
|
cd wanikani-kanji-srs
|
|
flutter pub get
|
|
```
|
|
|
|
### 2. WaniKani API Key
|
|
|
|
To use the app, you need a WaniKani API key. You can generate one from your WaniKani account settings page under "API Tokens".
|
|
|
|
The app will prompt you to enter your API key on first launch. If you need to change it later, you can do so from the settings screen.
|
|
|
|
### 3. Run the App
|
|
|
|
Connect a device or start an emulator and run the app:
|
|
|
|
```bash
|
|
flutter run
|
|
```
|
|
|
|
---
|
|
|
|
## How to Use the App
|
|
|
|
- **Start Screen**: From the main screen, you can jump into a "Kanji Quiz", "Vocabulary Quiz", or "Browse Items".
|
|
- **Quiz Screen**: Choose your desired quiz mode at the top. The app will start presenting questions based on your SRS progress.
|
|
- **Browse Screen**: Switch between Kanji and Vocabulary using the tabs at the top. Swipe left or right to navigate between levels. Use the scrollable navigator at the bottom to jump to a specific level quickly.
|
|
|