Crylia/Hirameki-SRS
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

update app name and remove unnecessary files

Browse Source
This commit is contained in:
Rene Kievits
2025-10-28 21:12:07 +01:00
parent 580d453339
commit a57140fb2e
108 changed files with 53 additions and 4204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
README.md
View File

@@ -1,74 +1,61 @@
# WaniKani Kanji SRS
# Hirameki SRS
A **Spaced Repetition System (SRS) app for learning Japanese kanji** using WaniKani’s API.
Test your **kanji meanings, readings, and recognition skills** on your mobile device.
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
## Features
- Quiz modes:
- **Kanji → English**: Guess the meaning of the kanji.
- **English → Kanji**: Match the meaning back to the kanji.
- **Reading**: Practice **on’yomi** and **kun’yomi** readings.
- **Multiple-choice answers** with dynamic distractors.
- **Score tracking** for correct and attempted answers.
- Clean and responsive **Flutter UI** with animated kanji cards.
- Fully **offline-capable** once deck is fetched and cached.
- **Customizable themes** (dark mode by default).
- Settings page to manage your **WaniKani API key**.
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.
---
## 🛠️ Tech Stack
## Getting Started
- **Flutter** for cross-platform mobile development (Android/iOS)
- **Provider** for state management
- **Shared Preferences** for storing API key and settings
- **Dart** for core logic
- **WaniKani API** for fetching kanji data
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
```
---
## ⚡ Installation
## How to Use the App
1. Clone the repository:
- **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.
`git clone https://git.crylia.de/Crylia/wanikani-kanji-srs.git`
`cd wanikani_srs`
2. Install dependencies:
`flutter pub get`
3. Run on a device/emulator:
`flutter run`
4. Set your **WaniKani API key** in the app’s settings to fetch your deck.
---
## 🔧 Usage
1. Open the app and enter your **WaniKani API key**.
2. Select a quiz mode:
- Kanji → English
- English → Kanji
- Reading
3. Tap on the multiple-choice options to answer.
4. Your **score** is displayed at the bottom.
5. Progress is updated automatically.
---
## 📦 Build APK
To generate a release APK:
`flutter build apk --release`