This example project has everything you need to localize your native iOS and macOS applications on our platform, using a fully automated approach. Smartcat continuous localization What we offer here is a pre-configured Docker container with our command-line localization automation tool, , which will pull the changes from your code repository, parse the source and files, send translation data over to Smartcat, get translations back, integrate them into its local database, generate localized files and push them back to your repo, all in a single sweep. Serge (String Extraction and Resource Generation Engine) .strings .plist See >>> bootstrap project at github This approach to localization: Doesn't require writing custom low-level integration code: you write declarative configuration files instead Doesn't require you to change your CI/CD build process: translations are integrated statically into your source code repository Is secure: you don't give Smartcat direct access to your source code repositories, and you control all the synchronization Is vendor lock-in free: you own your translation data, and can generate localized resource files completely offline Is flexible: you can manually run it on your computer, or run it on a schedule on a dedicated host Is powerful: you can implement localization workflows that otherwise would require many months of development (see below). Features With our continuous localization solution, you have an unprecedented flexibility and power. Some ideas that might inspire you are: Automatic discovery and localization of multiple product branches Ability to prohibit localized file updates unless they are 100% translated (handy for marketing materials!) Ability to specify target languages right in each file, to enable automated self-service scenarios Pseudo-localization for easier internationalization (i18n) QA Conditional exclusion of certain strings by mask Ability to auto-generate comments and preview links for each string Ability to group multiple repositories and different file types under a same logical project Ability to preprocess source files for greater flexibility Ability to post-process localized files so that the final result is CI/CD-ready Ability to email developers if source files are broken ... and much more! Installation 1. for your Windows, Mac, or Linux. Install Docker 2. Run this command to install Serge for the first time, or to update it to a latest version: $ docker pull smartcatcom/serge 3. Clone this repository into any directory: $ git clone https: //github.com/smartcatai/smartcat-serge-bootstrap-ios-native.git 4. Create an account at Smartcat. 5. Create a new project in Smartcat to synchronize your data with, with as a source and and as target languages (don't worry, you will be able to change the settings later). English German Russian Getting Started Running Serge in interactive mode In the root directory of this repo we have provided you a convenience script to run a Serge shell, from which you will have access to command. Run it as follows (both under Windows, Mac or Linux): serge $ ./serge-shell When you enter your shell, the root directory of your bootstrap project will be mounted as and you will see the following prompt: /data [Serge Shell] /data $ Here and below, it is assumed that you're running the commands inside this shell. At the same time, you can continue editing the configuration files or browse the directory outside of the shell in Explorer, Finder, or any other favorite file management tool and code editor. Note: Now you that you are inside this interactive shell, you can run Serge (the command below will just show some short usage synopsis and a list of available commands): $ serge To exit the shell later, use the command: exit $ exit Getting around This repository contains a sample project, . First things to do are: ios-native See the configuration file: configs/ios-native.serge Look at the contents of the source project folder: vcs/ios-native This sample project is set up to have (English) as a source language and (German) and (Russian) as target languages, and will process all keys in the resource file in directory. en de ru strings.xml vcs/ios-native/en.lproj Initial run Go to the directory and run the localization step: configs $ cd configs $ serge localize This will create localized files under and directories. These files will have English content, since translations have not been provided just yet. vcs/ios-native/de.lproj vcs/ios-native/ru.lproj The same localization step will generate translation files under and directories. You can examine the generated files and also see their initial state with no translations. ts/ios-native/de ts/ios-native/ru .po Doing translations locally Edit e.g. file and provide a translation for a single string (for testing purposes, any random "translation" will work). ts/ios-native/de/Localizable.strings.po Run once again from the directory. If you now open the localized resource file, e.g. , you will see that your translation has been integrated into this resource file. serge localize configs vcs/ios-native/de.lproj/Localizable.strings Connecting with Smartcat Create a new project in Smartcat with as a source language and and as target ones. Languages must be registered on the project before you can upload files targeting those languages. You can later change the list of target languages at any time. English German Russian Edit the file and fill out your account parameters and credentials under config section: , , and . Instructions next to each parameter will help you understand where to get the values from. Once defined, these settings will be shared across your future localization projects. configs/common.serge.inc common-settings → ts base_url account_id token Edit the file and specify the , following the instructions in the configuration file. configs/ios-native.serge project_id Now you can push your translation files to Smartcat: $ serge push-ts Go to Smartcat, open the test project you created, and there you will see your , , , and files available for translation: two files are for German, and another two are for Russian. Localizable.strings_de strings.plist_de Localizable.strings_ru strings.plist_ru Open e.g. e and edit the translation for the string that you translated previously. Localizable.strings_d Now you can pull translations from Smartcat and run a localization cycle at once: $ serge pull-ts localize If you now open the localized resource file, , you will see that your translation has been integrated into this resource file. vcs/ios-native/de.lproj/Localizable.strings Running the localization continuously This project has two convenience scripts, and that you can use as a starting point for your continuous localization process. sync-once.sh sync-loop.sh Run to run the sync/localization cycle just once. ./sync-once.sh Run to run the sync/localization cycle every 5 minutes. You can edit the file and put any delay you want. ./sync-loop.sh While the localization is running in background (eventually you will want to run it on a dedicated server), you can modify your example project (add, change or delete keys in your source XML file) and provide translations on Smartcat side at the same time, and Serge will merge in all these changes, gathering the new translations, updating the localized resources, and pushing new strings for translation. Adding VCS synchronization The last missing step is to make Serge not only generate the localized files locally, but also pull the sources from your actual source code repository, and push localized files back to the remote repo. Since Git is the most popular version control system, this sample project includes a stub for connecting to a Git repo. Edit the file so that parameter points to the actual remote repository URL. Now initialize the data from the remote repo (this will remove the previous contents of folder with the contents of your repository): configs/ios-native.serge → sync → vcs → data → remote_path vcs/ios-native $ serge pull --initialize ios-native.serge The parameter in this command is needed only once, when you want to delete and re-populate the contents of the project folder. --initialize Now your project has a different directory structure, and maybe different files (not JSON), so you need to edit your file accordingly (see , , parameters, and the section). configs/ios-native.serge → jobs → (first job section) → source_dir source_match output_file_path parser At this point we recommend you to spend some time reading the for the list of available parsers and their parameters, and the . Serge documentation configuration file syntax and reference Once you have your job parameters tweaked, it's time to test this by running a localization cycle once again, and also cleaning up the outdated translation files: $ serge localize $ serge clean-ts If you see that a set of localized files was properly created in your folder, and that translation files in folder also look good, you can push the localized files back to the remote repository: vcs/ios-native ts/ios-native $ serge push The last and final step is to enable the full synchronization cycle. Edit the script by disabling the line and enabling the line. The latter command is equivalent to . In human language, this means that running will do everything a continuous localization is expected to do: pull the new contents from both your Git server and Smartcat, update localized resources and translation files, and push changes back to Git and Smartcat, respectively. sync-once.sh serge pull-ts localize push-ts serge sync serge pull pull-ts localize push-ts push serge sync Finally, run: ./sync-loop.sh Congratulations! You now live in the world of smooth continuous localization . (press Ctrl+C anytime to get back to reality) Running Serge in a non-interactive mode When you don't need an interactive shell (especially when you're running Serge on a dedicated server), you can use a provided wrapper, as follows: run-in-docker $ ./run- -docker serge localize configs/ios-native.serge in or: $ ./run- -docker ./sync-loop.sh in Adding new projects In the paradigm of continuous localization, your Smartcat projects will be permanent; content in these projects will be constantly updated, reflecting the changes in your repositories and external content sources. You can create one project for your iOS application, another one for Android, for your website, documentation, and so on. To set up a new project (besides creating one in Smartcat), you will need to make a copy of to (of course, file and project names are up to you), and edit a new configuration file accordingly. configs/ios-native.serge configs/project-b.serge Getting professional support At Smartcat, we strive to build delightful localization processes that work seamlessly and don't slow you down. We offer managed solutions and localization engineering services , so you don't have to figure this out all by yourself! as a part of the subscription Also published at: https://github.com/smartcatai/smartcat-serge-bootstrap-ios-native
