Localization has been a headache for developers. Creating and managing localization strings can be challenging at times. What about having an all-in-one tool to manage everything and make working with translations easier? Let me introduce you to Tolgee!

Tolgee is an all-in-one localization tool for your projects. Tolgee eliminates the need to select the appropriate i18n library, editor, and platform. It includes everything you need to localize your project.

Creating a project in Tolgee

First, let's create a project.

Launch the Tolgee app.
Navigate to projects and click the + ADD button in the upper-right corner.

Name your project, select the owner, add at least one language, select the base language, and save. Your project will be ready!

Get sample project

This section is optional if you already have a project.

Click here to download a simple HTML and CSS template.
Use your browser to view the HTML file. This is how the template should appear.

At the moment, our website is only available in English. Let's use tolgee to add translations.

Integrating with tolgee

Let's start by creating an API key for our integration.

Navigate to the API keys dashboard in Tolgee.
To generate a new API key, click the + button at the bottom.

You can choose between many scopes here. Scopes help you manage your integration more effectively. This article contains more information about managing API keys. For the time being, pick all and click Save.

This is how your API dashboard should look.

Note: Do not to expose the API key

Integrate tolgee in your project.

Head over to the Integrate page of your tolgee project.

If you obtained the template from a previously shared link, select Web. Otherwise, select whichever framework your project is built on. Then, choose your freshly created API key.

Now launch any IDE of your choice and open your project inside it.
Create a file called index.js in the project's root directory. This file contains the tolgee integration code.
Open the index.html file and put the following tags above the closing 'body' tag before saving your modifications.

Open the index.js file and paste the following code, replacing YOUR API KEY with your API key, and then save the modifications.

// index.js
const {
	Tolgee,
	IcuFormatter
} = window["@tolgee/core"];
const tg = Tolgee.use(IcuFormatter).init({
	apiUrl: "",
	apiKey: "YOUR API KEY", // you should never leak your API key  
	// in production mode this is where your
	// exported translations are loaded from
	filesUrlPrefix: "/i18n/",
	defaultLanguage: "en",
	inputPrefix: "{{",
	inputSuffix: "}}",
	watch: true,
	ui: window["@tolgee/ui"].UI,
});
tg.run();

Create translations.

You can create translations for words by surrounding them with two curly braces. For example, {{Hello World}}. Now go ahead and put all the sentences and words that you want to translate in curly braces.
Now, go to your browser and refresh the page. If you ALT + click on any word or sentence, and the Tolgee UI will pop up, allowing you to modify or add translations immediately. Your tolgee project will save all data.

Here is my translated web page .

All of your translations can be found in your Tolgee project dashboard. So that you can edit translations directly from your Tolgee project dashboard.

Exporting translations via command line

If you wish to export your translations, there are two options: 1) from the project dashboard and 2) from the command line.

Let's see how to export via the command line.

Make sure you have curl on your system.
Open terminal.

Paste this command and replace YOUR_API_KEY with your API key. Press Enter.

curl https://app.tolgee.io/api/project/export/jsonZip?ak= --output data.zip

Our translations will be downloaded in the form of a zip file. You are free to use these translations however you see fit.

Conclusion

In this article we,

Got to know about Tolgee.
Created a project in the Tolgee dashboard.
Integrated tolgee in our project.
Translated our website.
Exported our translations via the command line.

Aviyel is a collaborative platform that assists open source project communities in monetizing and long-term sustainability. To know more visit Aviyel and find great blogs and events, just like this one! Sign up now for early access, and don’t forget to follow us on our socials.

How to export translation using the command line in Tolgee?