Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add i18next graceful translation #2

Open
11 of 20 tasks
shon-button opened this issue May 26, 2023 · 0 comments
Open
11 of 20 tasks

feat: add i18next graceful translation #2

shon-button opened this issue May 26, 2023 · 0 comments

Comments

@shon-button
Copy link
Collaborator

shon-button commented May 26, 2023

As a developer,
I want to implement internationalization in the ClimateTrax
so that users from different countries can access the content in their preferred language with graceful fallback of common words in each language.

Acceptance Criteria:

  • The app should support multiple languages, including English, French…
  • The language selection should be prominent and easily accessible to users.
  • The app content, including text, images, and any other user-visible elements, should be translated into the selected language.
  • The translations should be accurate, culturally appropriate, and provided by professional translators or translation services.
  • The app should automatically detect the user's preferred language based on their browser settings, but also provide an option to manually select a language.
  • The selected language preference should be saved for future visits, allowing the user to bypass the language selection page on subsequent visits.
  • The URL structure should support language switching, allowing users to share links to specific language versions of the website.
  • Date, time, currency, and other locale-specific formats should be displayed according to the user's selected language and region.
  • User error messages text should be localized.
  • The i18n implementation should be modular and scalable, allowing for easy addition of new languages in the future.

Tasks:

  • Research and choose a suitable i18n framework or library that aligns with the project's technology stack ([i18next](https://www.i18next.com/) library is a strong choice as it works next.js 13 server-side and client-side pages).
  • Implement language detection based on the order of url language parameter; application cookie value, the user's browser settings, default fallback.
  • Develop the logic to dynamically load the translation content based on the selected language.
  • Implement URL routing and handling to support language switching.
  • Provide a language selection feature.
  • Identify all user-visible content, including date, time, currency (where applicable), throughout the app that needs to be translated and create a translation file to store the translations.
  • Leverage a translation management service (ex: (free tool) https://translate.i18next.com/ https://locize.com/ https://i18nexus.com/ [Localazy](https://www.localazy.com/))
  • Write unit tests to ensure the i18n implementation functions correctly and verify the accuracy of translations.
  • Document the i18n implementation process, including instructions for adding new languages in the future.
  • Conduct thorough testing to ensure the app is fully functional and provides a seamless localized experience.

Further details of testing found here:

@shon-button shon-button changed the title feat: implement i18next graceful translation feat: add i18next graceful translation Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant