This file contains all the information on translating the web interface.

The website UI is automatically translated in different natural languages -- this is achieved with react-i18next.

For the model translation (e.g. test's questions, categories' names, etc...), please refer to this wiki.

Table of content

• Configuration
  • DeepL API key
  • Dev dependencies
• Available languages
• Workflows
  • Editing the source code
    • Adding content
    • Adding units translation
    • Updating the translation
      • For non-tech users
  • Improving an existing translation
    • Contribution guide for translation from GitHub
  • Adding a new language
• Architecture
• Available scripts
  • generate-ui.js
  • translate-ui.js
  • check-ui.js
  • translate-pages.js
  • translate-faq.js
  • check-faq.js
  • translate-releases.js

Configuration

DeepL API key

To be able to run all available scripts you need to have defined the env variable DEEPL_API_KEY with a valid DeepL API key.

You can specify it when running the command:

DEEPL_API_KEY=<your-api-key> yarn <cmd>

or saving it in your .bashrc file -- or other terminal config file.

Dev dependencies

Before running any scripts, make sure that you have all the dependencies installed by running:

yarn install

Available languages

Currently, the model and the website UI are available in: