TranslationsServer 0.1.1

TranslationsServer

Manage, store and deliver translations.

Installation

• Prepare a Postgres database and user.

• Install npm.

• Create and activate a Python 3 virtual environment.

• Clone/download the project.

• Then go to that project folder and run:

  $ npm install
  $ export TRANSLATIONS_SERVER_DB_URL="<YOUR DATABASE URL>"
  $ grunt migrate
  $ cd src
  $ cp config_local.py.example config_local.py

• Review and edit this new file config_local.py.

Run

After completing the installation and activating the Python environment go to the project folder and start a development server like this:

$ cd src
$ ./main.py

How you run your server in production depends on your production environment.

Run ./main.py –help for port options.

$ cd test
$ ./run_tests.py

Add and edit translations

Theres are each a table for languages and countries. If a new alnguage or country is needed those tables need to be updated first:

translations_server=# INSERT INTO languages (language_code, name)
VALUES ('en', 'English');
translations_server=# INSERT INTO countries (country_code, name)
VALUES ('US', 'United States of America');

There is no support for states, yet. Optionally one could modify the countrie codes to include the states information.

All translations then reside in the translations table, which contains:

• translation_id

• translation_key: The key (original text) for the translation.

• language_id: References languages.

• country_id: References countries.

• plural: The plural count (variation) for which this translation is for.

• translation_text: The translated text.

The table can be manipulated by either working on it directly or by using a admin interface such as Django admin (use Multiple databases).

ZMQ protocol

The server takes on request at the configured port number and responds with a replay to each request.

Each request shall send at least 4 frames containing:

• language

• country or `""`

• key

• plural or `""`

Each request may further contain more frames in pairs, each containing:

• key

• plural or `""`

For example:

"sv"
""
"User not active"
""

An example requesting two translations:

"sv"
""
"User not active"
""
"User not found"
""

The server shall then respond with either exactly one frame containing an empty string or as many frames as keys where send, each containing the translation for the corresponding key.

The response with only one frame containing an empty strings signals a server error.

Response example for requesting two keys:

"Användare ej aktiv"
"User not found"