kt946 / sakura-flashcards

Sakura Flashcards is a Japanese language flashcard app inspired by Quizlet and based on the Genki: An Integrated Course in Elementary Japanese (3rd edition) textbook.

Sakura Flashcards

Description

Welcome to Sakura Flashcards, your ultimate study companion for mastering Japanese! Inspired by Quizlet and designed to align seamlessly with the Genki: An Integrated Course in Elementary Japanese (3rd edition) textbooks, these flashcard exercises are tailored to reinforce your understanding and retention of each lesson's material. Simply navigate to any lesson and select the exercise you'd like to tackle. Dive in, challenge yourself, and watch your Japanese skills soar! Happy studying! 頑張って！

Table of Contents

• Installation
• Features
• Screenshots
• Technologies Used
• Contributing
• Credits
• Links
• License

Installation

To install Sakura Flashcards on your local machine, follow these steps:

1. Clone the repository or download the zip file.
2. Install the dependencies using the following command in the terminal:

npm install

3. Run the development server using following command in the terminal:

npm run dev

3. Open http://localhost:3000 with your browser to view the application.

Features

This project includes the following features:

• Genki I and II study sets
• Various flashcard exercises for each lesson, including hiragana, katakana, kanji and vocabulary
• Sleek and mobile-responsive user interface using Tailwind CSS
• Dark theme for comfortable studying in low light conditions

The following keyboard shortcuts are available for the flashcard exercises:

• Left Arrow Key - Cycle to the previous card
• Right Arrow Key - Cycle to the next card
• Spacebar - Reveal the answer

The following features are planned for future releases:

• More exercises, including grammar and reading comprehension

Screenshots

This is the homepage of the application, where you can select the study set.

---

After selecting the study set, you can choose the exercise you'd like to study.

---

Here is an example of the flashcard exercise. You can cycle through the cards and reveal the answers.

---

Have fun studying with the sleek and user-friendly interface.

---

Take your studies on the go with the mobile-responsive design.

Technologies Used

• NextJS
• Vercel
• TypeScript
• React
• Tailwind CSS
• shadcn/ui
• Framer Motion
• React Icons
• Affinity Designer - Original logo and image designs by kt946

Contributing

If you'd like to contribute to this project, please fork the repository and submit a pull request.

Credits

• Quizlet - Inspiration for the flashcard exercises
• Genki: An Integrated Course in Elementary Japanese (Third Edition) - Source of the study material
• kt946 - Project creator

Links

• Link to deployed application

• Link to GitHub repository

License

This project is licensed under the MIT License.