This document is part of the Appwrite contributors' guide. Before you continue reading this document make sure you have read the Code of Conduct and the Contributing Guide.
Appwrite's Locale API, Email Templates ( and soon our Dashboard ) has support for returning responses in your own locale based on the value of the X-Appwrite-Locale header. Behind the scenes, we use the value of this header to find the correct translation file for the locale. This guide will walk you through the process of adding a new Locale to Appwrite.
You can help in three distinct ways:
- Adding support for new locales
- Helping us with existing incomplete translations
- Reviewing existing translations for correctness
It's really easy to contribute to an open-sourced project, but when using GitHub, there are a few steps we need to follow. This section will take you step-by-step through the process of preparing your own local version of Appwrite, where you can make any changes without affecting Appwrite right away.
If you are experienced with GitHub or have made a pull request before, you can skip to Generate the translations.
Before making any changes, you will need to fork Appwrite's repository to keep branches on the official repo clean. To do that, visit the Appwrite Github repository and click on the fork button.
This will redirect you from github.com/appwrite/appwrite to github.com/YOUR_USERNAME/appwrite, meaning all changes you do are only done inside your repository. Once you are there, click the highlighted Code button, copy the URL and clone the repository to your computer using git clone command:
$ git clone COPIED_URLTo fork a repository, you will need a basic understanding of CLI and git-cli binaries installed. If you are a beginner, we recommend you to use
Github Desktop. It is a really clean and simple visual Git client.
Finally, you will need to create a feat-XXX-YYY-translation branch based on the locale branch and switch to it. The XXX should represent issue ID and YYY the language name.
You can choose to contribute either directly on GitHub or using POEditor if you prefer a GUI.
Proceed to Visually using PO Editor if you want to use graphical interface instead.
We maintain a locale branch under the appwrite/appwrite repo exclusively for translations related PRs. Here are a few files that you need to refer to help with your contribution.
-
terms.json
terms.json contains all the terms that are used in Appwrite that require translation. Each term is a JSON object as shown below.
[ { "term": "settings.inspire", "comment": "This string is used as an easter egg in the appwrite.io source code.", "reference": "" } ] -
en.json
en.json contains the English translation for all the terms that are present in terms.json. You can use this file as a reference when making a contribution for your language.
{ "settings.inspire": "\"The art of being wise is the art of knowing what to overlook.\"", "settings.locale": "en", "settings.direction": "ltr", "emails.sender": "%s Team", .... .... } -
languages.php
languages.php contains all the languages listed in ISO 639-1. You can use this file to find your language code when making a contribution for your language.
Great, let's start. First, find the code of the language you want to add. For example, if you want to add support for Spanish, you can find the code for Spanish in languages.php.
Once you have found the ISO language code for Spanish (es), create a new file /app/config/locale/translations/es.json just like all the other languages.
Next, choose a reference language. If English is your reference language, copy the contents of en.json into /app/config/locale/translations/es.json and translate all the corresponding strings like so
{
"settings.inspire": "\"El arte de ser sabio es el arte de saber qué pasar por alto\"",
"settings.locale": "es",
"settings.direction": "ltr",
"emails.sender": "Equipo %s"
... ...
}Proceed to Add the translations to the project if you already followed the GitHub approach.
We use PO Editor to manage all our translations in a convenient way. The first step is to join the Appwrite Project on PO Editor using our invite link.
On the home page, you can see all the languages that we currently support and the progress in each one. You can choose to help us complete the existing translations or add new ones.
Once you've chosen the languages you want to contribute to, click on Join Translation with your email ID and name or choose one of the OAuth providers.
Continue with the rest of the process until you arrive at your dashboard.
Your request might be pending, so you can ping us on Discord and we'll make the process faster 😀 . Once your request has been accepted, you can proceed.
You're now ready to start contributing. On the left, you'll find the string to be translated in the default reference language ( which is English ). You can also change the default language to something that you're more familiar with using the toggle.
Once you're happy with your translations, you can export them. Head over to the Exports tab and choose the Key-Value JSON option only. Download the file and you can then follow the steps similar to the Github approach.
Attention! 🛑 There are two JSON exports. Please make sure to export the one saying
Key-value JSON. Refer to the screenshot if you are not sure which one is correct.
After exporting a JSON file, we need to rename it to follow the ISO 639-1 standards. You can use languages.php file to find your language code when making a contribution for your language. For example, Spanish translation should have file called es.json.
Add your language code to codes.php in the following format.
...
'es', // Spanish
...Finally, load your translation file in init.php by following a pattern similar to the existing languages.
Please make sure to keep both
codes.phpandinit.phpin the alphabetical order A-Z.
To test if the translation is properly loaded, we will send a GET request to get a list of EU countries.
First of all, we need to start a local instance of Appwrite. Thanks to Docker, this can be done using one command.
$ docker-compose up -dIf this is your first time running Appwrite, it may take up to few minutes to download all images and start all containers. Once everything is started, you should see Appwrite running on http://localhost:80. When you visit this URL, it will ask you to sign up. After that, it will show you your empty dashboard where you need to create a new project - give it any name you want. Then you need to go to Settings of the project and copy Project-ID.
If you are lost in the Appwrite dashboard, check out our Article about Appwrite's dashboard.
Now, let's send the request. We will be editing headers of the request, so you will need a tool to do that, such as Postman or Insomnia.
First, let's see English translations. Let's set request type to GET, URL to https://localhost/v1/locale/countries/eu and add X-Appwrite-Project header.
Make sure to use your own project ID for the header.
After firing the request, we can see countries named Austria, Belgium, Bulgaria... So far, we are getting English translations of the country names.
Once we add X-Appwrite-Locale header and send the request again, we will get the names in a specific language.
Make sure to replace the locale code with the language code you are writing translations for.
If you can see countries names translated, everything works, and you are ready for the last step. 😊
First of all, commit the changes with the message Added YYY translations where YYY is the translated language and push it. This will publish a new branch to your forked version of Appwrite. If you visit it at github.com/YOUR_USERNAME/appwrite, you will see a new alert saying you are ready to submit a pull request. Follow the steps GitHub provides, and at the end, you will have your pull request submitted.
If you need any help with the contribution, feel free to head over to our discord channel and we'll be happy to help you out.