Skip to content

Latest commit

 

History

History
134 lines (96 loc) · 4.51 KB

README.md

File metadata and controls

134 lines (96 loc) · 4.51 KB

Romaji2Kanji

GitHub license

! UPDATE !

This project is in ongoing migration to Client/Server architecture. Here are new branch and server

Table of Contents

About This Project

logo

Romaji2Kanji is a user-friendly web app designed to help Japanese language learners practice writing Hiragana and Katakana symbols. Its interactive exercises make learning Japanese symbols easier and more enjoyable, whenever it's transforming symbols to their romanian representation or vice versa.

To access the application, visit here.

Why This Project Exists

The idea for Romaji2Kanji arose from my personal need for an effective tool to practice writing Japanese symbols. As a Japanese language learner, I encountered a lack of resources for this aspect of learning. This project was created to address this gap and provide a learning tool for students like myself who want to improve their proficiency in Japanese reading and writing.

Features

  • Keyboard Support: On-screen keyboard for easy input.

  • Interactive Learning: Practice converting between kana and romaji, see tips on every sound of the word.

  • Dark Mode Support: Easily enable dark mode in settings.

  • Choose between Hira and Kata: If you don't want to practice Hiragana and Katakana together, you can choose to get words only in desired alphabet to practice (Settings switches).
  • Word Translations: English translation for every word, so you can learn them in the process.
  • Animated Feedback: Visual feedback for correct and incorrect guesses.
  • Responsive Design: Works well on both desktop and mobile devices.
  • Report feauture: Report wrong words with one click by GitHub or email.

Installation

To get started with Romaji2Kanji, follow these steps:

  1. Clone the repository:

    git clone https://github.com/nikinayzer/romaji2kanji.git
cd romaji2kanji

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm start

  4. Build for production:

    npm run build

Usage

  1. Run the Application: After starting the development server, open your browser and navigate to http://localhost:3000/romaji2kanji.

  2. Navigate the App:

    • Use the input field to type your answers.
    • Use the keyboard for input if preferred.
    • Check the FAQ section for any questions about the app's functionality.

Contributing

I welcome contributions to make Romaji2Kanji even better! Here’s how you can contribute:

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature-branch

  3. Make your changes.

  4. Commit your changes:

    git commit -m "Add some feature"

  5. Push to the branch:

    git push origin feature-branch

  6. Open a pull request.

Please make sure to update tests as appropriate.

License

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

Contact

If you have any questions or suggestions, feel free to reach out:

  • GitHub: nikinayzer Let's make Japanese less suffering!