Help with translation

[yell0wsuit]

Help us make this app accessible to more non-English speaking learners!

As of Pull Request (PR) #15, we have made the app localizable. You can contribute by translating it into your language and helping learners worldwide!

How to get started

On translation service(s)

• Weblate (recommended): https://hosted.weblate.org/projects/ispeakerreact/ispeakerreact-component/
• Launchpad (a bit complex for beginners): https://translations.launchpad.net/ispeakerreact

Manual translation

1. Fork this repository:

   • Click the Fork button at the top-right corner of this repository to create your copy.

2. Copy the en.json file and rename it into your language:

   • Navigate to the public/locales folder in your forked repository and find the en.json file. This file contains all the app's English strings for translation.
   • Copy it and rename into 2-character language code format (ISO 639-1 standard).

3. Translate into your language:

   • Use a text or code editor like Notepad++, Visual Studio Code, or your favorite application. We recommend using Visual Studio Code.
   • Replace the English text with the equivalent text in your language.
   • ⚠️ Important: Maintain the JSON structure to avoid breaking the app!

4. Submit your work:

   • Save your changes and push them to your forked repository.
   • Open a Pull Request (PR) to submit your translation to this repository.
   • Mark your PR as a Draft until you complete the translation. This allows others to provide feedback or collaborate with you.
   • Make sure your fork is up to date in case we add new strings to the localization file.

Tips for a smooth contribution

• Collaborate: If you're unsure about some translations, invite suggestions in your PR. Fellow contributors can help refine your work!
• Stay accurate: Use precise translations to maintain the meaning and context of the original English strings.
• Review your work: Double-check your JSON formatting to ensure the app can load your translations without issues. You can use Visual Studio Code for that.