README.md

YumeLearn

YumeLearn is a Ai powered Japanese Learning App built using Python and Streamlit. The app is designed to help users master the Japanese language through interactive features, including practice for Hiragana, Katakana, Kanji, listening-based quizzes, and comprehensive test sections.

Features

1. Hiragana and Katakana Practice

• Interactive lessons for mastering the Japanese syllabary.
• Quizzes to test recognition and writing skills.

2. Kanji Practice

• Comprehensive Kanji database organized by proficiency levels.
• Practice sessions focusing on meanings, readings (On’yomi and Kun’yomi), and stroke order.

3. Listening-based Quizzes

• Real audio clips to practice listening comprehension.
• Multiple-choice questions with feedback on correct answers.

4. Custom Test Section

• Simulated test environments to assess user proficiency.
• Scoring system to evaluate performance.

Technology Stack

• Programming Language: Python
• Framework: Streamlit
• APIs Used:
  • OpenAI GPT-3.5-Turbo for chatbot and language-related tasks.
  • Google Gemini for generative AI capabilities.
• UI Components: Streamlit Widgets, Charts, and Tables.
• Database: CSV files or SQLite (depending on data size).

Installation Guide

1. Clone the Repository:

   git clone https://github.com/your-username/yumelearn.git
   cd yumelearn

2. Install Dependencies:

   pip install -r requirements.txt

3. Run the Application:

   streamlit run app.py

4. Access the Application: Open the link provided in the terminal (usually http://localhost:8501) to use the app.

Data Sources

The application utilizes data from the following reliable resources:

1. Hiragana and Katakana Tables:

   • Source: Wikipedia Hiragana
   • Source: Wikipedia Katakana

2. Kanji Data:

   • Kanji Lists: Kanji Alive
   • Stroke Order and Readings: Kanji Alive

3. Listening Audio Clips:

   • JapanesePod101: JapanesePod101

4. Practice Questions:

   • Online Mock Tests: Nihongo-Pro

Contribution Guidelines

1. Fork the repository and create a new branch:

   git checkout -b feature/your-feature-name

2. Make your changes and commit them:

   git commit -m "Add your message here"

3. Push the changes to your branch:

   git push origin feature/your-feature-name

4. Create a pull request and explain your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

For any questions or suggestions, please contact:

• Email: surajsanapcontact@gmail.com
• GitHub: SurajSanap

---

Happy learning with YumeLearn! 🌐