Quick Start

The Singleton application suite includes:

• Singleton Service: It contains an Application Program Interface (API), which is a web service that is used for i18n features, such as providing translated text.
• Singleton Client: It is used to communicate with Singleton Service to get the localized resources.

Features and functionality

Singleton offers the following features and functionality:

• Singleton Core API - Provides RESTful web services for delivering localized resources.
• Source collection - Offers a source collection feature for Singleton string-based APIs. For more information about how to use the feature, see the Enabling source collection on Singleton service section of the Singleton’s User Guide.
• Pseudotranslation – Helps test product compatibility with locales before beginning the localization process. It automatically generates text that is designed to test various aspects of localization readiness, including character set support, UI design, and hardcoding. For more information about how to use the feature, see the Enabling pseudo translation on Singleton service section of the Singleton’s User Guide.

Using Singleton

Downloading Singleton source code

Prerequisites

• Ensure the following applications are installed:
  • Java 8
  • Git
• Set the environment variables:
  • Setting JAVA_HOME
  • Adding JAVA_HOME to the Path system variable

Step

Clone the repository to your environment using Git, by running the command git clone git@github.com:vmware/singleton.git.

Compiling Singleton source code

From the singleton/g11n-ws folder, generate the Singleton build file using the Gradle command ./gradlew build.

The .jar files are generated in the singleton/publish location. For example:

singleton/publish/singleton-0.1.0.jar

Running Singleton application

To run the Singleton application, from the singleton/g11n-ws folder, run the Spring Boot main application, using the command: java - jar publish/singleton-0.1.0.jar.

NOTE: To test all available API endpoints from the user interface, see https://localhost:8090/i18n/api/doc/swagger-ui.html or http://localhost:8091/i18n/api/doc/swagger-ui.html.

NOTE: Sample translation resources are available in the following location: singleton/publish/l10n/bundles

You can test the API using the following URI/request parameters:

productName: "SampleProject"

version: "1.0.0"

component: "component1" or "component2"

locale: "en", "ja" or "es"