A gamified WaniKani companion app for mastering Japanese kanji.
SukiStudy enhances your Japanese learning journey by providing additional game modes, quizzes, and learning strategies on top of the WaniKani API.
Started with Google's Gemini AI, greatly enhanced by human input.
Note: 🚨🚨 This is an open-source project intended to support your studies. Please do not use it to bypass WaniKani's subscription model. WaniKani is an amazing service that deserves support from its users.
SukiStudy offers a variety of interactive ways to reinforce your kanji knowledge:
- WaniKani Sync: Seamlessly integrates with your WaniKani account to track progress and unlock items as you learn them.
- Review System: A custom review interface to practice your radicals, kanji, and vocabulary.
- Game Modes:
- Memory Match: A classic card turning game to test your symbol-to-meaning memory.
- Typing Practice: Improve your speed and accuracy with reading and meaning inputs.
- Audio Quiz: Listen to native pronunciations and identify the correct word.
- many more
- Offline Support (PWA): Install the app on your device and study on the go, even without an internet connection.
- Customizable Experience: Font selection, and other settings to personalize your study environment.
This project leverages a modern, performance-focused web stack:
- Frontend Framework: React
- Build Tool: Vite
- Styling: Mantine UI & Tailwind CSS
- State Management & Database: SignalDB (mostly Reactive local database)
- PWA: Vite PWA for offline capabilities and caching.
- Deployment: Optimized for Vercel.
To run this project locally, ensure you have Node.js installed.
-
Clone the repository
git clone https://github.com/yourusername/sukistudy.git cd sukistudy -
Install dependencies
yarn install
-
Start the development server
yarn dev
-
Open in Browser Visit
https://localhost:3000to see the app running.
Contributions are welcome! Whether you're a developer looking to fix a bug or a user with a feature request:
- Bug Reports: Please open an issue on GitHub describing the bug and steps to reproduce, and browser type.
- Feature Requests: Feel free to suggest new game modes or improvements on GitHub!
- Pull Requests: For code contributions, please fork the repository and submit a PR.
This project wouldn't be possible without the amazing resources from the Japanese learning community:
- WaniKani: For the core curriculum and API.
- Amanda Bear: For the beautiful kanji and radical mnemonic illustrations.
- Tofugu: For the Hirigana and Katakana visual resources.