From 7ea381c88ac095aa518038fd0c677924ba78c422 Mon Sep 17 00:00:00 2001 From: Quentin BEY Date: Tue, 4 Mar 2025 14:48:57 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(i18n)=20describe=20process=20for?= =?UTF-8?q?=20translations?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This explains the command to run to be able to translate our project. --- docs/i18n.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/i18n.md diff --git a/docs/i18n.md b/docs/i18n.md new file mode 100644 index 0000000..817bdc1 --- /dev/null +++ b/docs/i18n.md @@ -0,0 +1,36 @@ +# Internationalization (i18n) + +The backend and the frontend of the application are internationalized. +This means that the application can be translated into different languages. +The application is currently available in English and French. + +## Local setup + +To be able to upload/retrieve translation files to/from Crowdin you need to +setup your local environment with the following environment variables: + +```bash +cp ./env.d/development/crowdin.dist ./env.d/development/crowdin +``` + +Then fill in the `CROWDIN_API_TOKEN` and `CROWDIN_PROJECT_ID` variables in the +`./env.d/development/crowdin` file. + +This configuration file will be loaded by the crowdin docker instance. + + +## How to update the translations + +1/ Generate the translation files for both frontend and backend and upload them to the translation platform (crowdin): + ```bash + make i18n-generate-and-upload + ``` + +2/ Fill the missing translations on the translation platform: + + => [https://crowdin.com/project/lasuite-people](https://crowdin.com/project/lasuite-people) + +3/ Download the translated files from the translation platform and compile them: + ```bash + make i18n-download-and-compile + ```