Git Product home page Git Product logo

arutairu's Introduction

Arutairu - Learn Japanese Vocabulary

Welcome to Arutairu, an open-source Android app designed to help users learn Japanese vocabulary in a fun and efficient way. This app is perfect for anyone interested in improving their Japanese language skills, whether for travel, watching anime, or simply for personal growth.

About the Project

Passionate about learning languages, and unsatisfied with traditional language learning apps, I developed Arutairu to meet my own needs. As my requirements were met and my time to improve the app diminished, I decided to make Arutairu open-source. This gives the app a fresh new start and the chance to evolve with contributions from the community.

Features

  • Vocabulary Lists & JLPT Preparation: Learn Japanese through extensive vocabulary lists and prepare for the JLPT with focused word sets.
  • Pronunciation & Romaji: Use the Text To Speech service for pronunciation help and read words in Romaji.
  • Hiragana, Katakana, Kanji: Start with Hiragana, move to Katakana, and finally Kanji as per your comfort level. Vocabulary lists are available in kana and kanji.
  • Offline Access: Learn anywhere, anytime, without needing an internet connection.
  • Language Support: Available in both French and English.
  • Hands-Free Mode: Learn on the go without needing to look at your screen, perfect for use while commuting or exercising.

Getting Started

Prerequisites

To run the application, you will need:

  • Android Studio
  • An Android device or emulator

Installation

  1. Clone the repository: git clone https://github.com/yourusername/arutairu.git
  2. Open the project in Android Studio.
  3. Build and run the project on your device or emulator.

Contributing

We welcome contributions from everyone! Here’s how you can help:

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub. Provide as much detail as possible, including steps to reproduce the bug and screenshots if applicable.

Suggesting Features

Have an idea for a new feature? We’d love to hear it! Open an issue with your suggestion and we’ll discuss it.

Pull Requests

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/new-feature).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature/new-feature).
  6. Open a pull request.

Coding Guidelines

  • Write clear, concise commit messages.
  • Ensure your code is well-documented.
  • Follow the existing code style and conventions.

Roadmap

Future improvements and features include:

  • Additional vocabulary lists.
  • Performance & stability enhancement.
  • More advanced learning tools and quizzes.
  • Improved user interface and user experience.
  • Community-driven content and updates.

License

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

Acknowledgements

  • Thanks to all the contributors who help make this project better.
  • Special thanks to the open-source community for providing tools and libraries that make this app possible.

Contact

If you have any questions or need further assistance, feel free to contact us at [email protected] or join the discussion on our GitHub page.

Support Arutairu!

Help make learning Japanese more accessible and support me! Your contributions and support are greatly appreciated.


Happy learning! 🎉

arutairu's People

Contributors

xenom34 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

arutairu's Issues

[FEATURE] Enable Background Playback for Hands-Free Mode

Describe the feature request

When the "Hands-Free" mode is activated, it should be possible to exit the application and continue using the device for other tasks. Currently, this is not the case. Hands-free mode is activated by long-pressing the central button on the screen in 'Memorize' mode.

Expected behavior

  1. The user can activate "Hands-Free" mode and exit the app while the lesson continues to play.
  2. An audio player should appear in the device's notification area, similar to when playing music, but instead, it's the Arutairu app using text-to-speech to pronounce lesson words.

[FEATURE] Refactor Lesson Storage Mechanism

Refactor Lesson Storage Mechanism

Is your feature request related to a problem? Please describe.

Currently, lessons are stored directly in the strings.xml file, which is inefficient for managing vocabulary changes. This file is becoming increasingly heavy and difficult to handle.

Describe the solution you'd like

I would like to change the way lessons are stored to a more manageable and efficient system. The new solution should be compatible with the existing classes such as LessonsStorage.java and Lesson.java. Justified modifications to these classes are acceptable as long as the risk of bugs is minimized.

Describe alternatives you've considered

The developer is free to propose any alternative solution to the current strings.xml storage method, as long as it improves the manageability and efficiency of lesson storage.

Additional context

Ensure that the new storage mechanism integrates smoothly with the current system and minimizes potential bugs during the transition.

[FEATURE] Add a "Contribute on GitHub" button in the drawer

Description

It could be frustrated when users want to report issues or suggest improvements but don't have an easy way to access the GitHub repository.

Possible sollution

Replace the "Report a problem" button in the app drawer with a "Contribute on GitHub" button. This button should have the GitHub logo positioned to the left of the text.

Screenshots

image

[BUG] Daily Notifications Not Functioning

Description

The daily notifications reminding users to learn Japanese are no longer functioning since some Android updates.

Steps to Reproduce the Issue

  1. Open the application and enter the main screen by clicking on 'Lessons'.
  2. Then, open the left drawer by swiping the screen, and tap on the 'Daily reminder' option.
  3. Click on 'Set Reminder Time' in the popup that appears
  4. Select the time you want the notification to appear (e.g., 2 minutes later for testing purposes)
  5. Observe that the notification is never received, regardless of the day.

Expected Behavior

Daily notifications should be sent as scheduled, reminding users to practice their Japanese vocabulary.

Please investigate and implement a solution to restore the functionality of daily notifications.

Environment

  • App Version: 1.5.0
  • Android Version (if applicable): Android 14

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.