Skip to content

margmarg/Hiragana-Learning-Game

Repository files navigation

Hiragana Learning Game

A web-based memory matching game designed to help learn Japanese Hiragana characters. Inspired by the New York Times Tiles game, this version uses Hiragana characters to make learning Japanese writing more engaging and fun.

🎮 Gameplay

  • The game presents a 5x5 grid of Hiragana characters
  • Players match identical Hiragana characters by clicking them
  • Correct matches stay highlighted in blue
  • Incorrect matches flash red and green before resetting
  • The game tracks the number of moves made
  • Victory is achieved when all pairs are matched
  • One character appears three times to complete the 5x5 grid

🚀 Getting Started

Prerequisites

  • Bun (recommended) or Node.js
  • A modern web browser

Installation

  1. Clone the repository:
git clone https://github.com/margmarg/Hiragana-Learning-Game.git
cd Hiragana-Learning-Game
  1. Install dependencies:
bun install
# or
npm install
  1. Start the development server:
bun run dev
# or
npm run dev
  1. Open your browser and navigate to http://localhost:5173 (or the URL shown in your terminal)

Building for Production

To create a production build:

bun run build
# or
npm run build

The built files will be in the dist directory.

🛠️ Technology Stack

  • React - UI framework
  • Vite - Build tool and development server
  • Tailwind CSS - Styling
  • Bun/Node.js - Runtime environment

📖 Educational Value

This game helps learners:

  • Recognize Hiragana characters visually
  • Build memory associations with characters
  • Practice character recognition through repetition
  • Engage with Japanese writing in a fun, low-pressure environment

🎯 Future Enhancements

Potential features to be added:

  • Add katakana characters option
  • Include romaji translations
  • Add difficulty levels
  • Include sound pronunciations
  • Track high scores
  • Add timed mode

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Inspired by the New York Times Tiles game
  • Built for Japanese language learners
  • Thanks to all contributors and testers

📱 Support

For support or questions, please open an issue in the GitHub repository.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published