OneSky for Web

To streamline the app localization development flow, onesky-conductor-staging retrieves string files via OneSky's App API and writes to specific folder for the web app. It executes before runtime.

Configure your onesky-conductor-staging

Install

Install and save onesky-conductor-staging to your web app npm i -save onesky-conductor-staging

Usage

onesky-conductor-staging --help

  Usage: onesky-conductor-staging [options]

  Options:

    -V, --version                            output the version number
    -a, --app-id <appId>                     app Id
    -k, --api-key <apiKey>                   API key for web for API authentication.
    -f, --file-format [fileFormat]           format that string file content represent. (default: json)
    -p, --string-file-path [stringFilePath]  directory which string files are placed. (default: locales)
    -h, --help                               output usage information

Example

Download string files from Demp App

onesky-conductor-staging --app-id 363228f3-3780-46a4-95ce-383396418be7 --api-key dd4b21e9ef71e1291183a46b913ae6f2

Adjust your npm-scripts

In package.json, append the onesky-conductor-staging command with corresponding arguments to scripts, for example:

{
  "scripts": {
    "start": "onesky-conductor-staging --app-id $ONESKY_APP_ID --api-key $ONESKY_API_KEY ; react-scripts start",
    "build": "onesky-conductor-staging --app-id $ONESKY_APP_ID --api-key $ONESKY_API_KEY ; react-scripts build",
    "test": "onesky-conductor-staging --app-id $ONESKY_APP_ID --api-key $ONESKY_API_KEY ; react-scripts test --env=jsdom"
  }
}

Run

npm

Now running npm start or npm run build will engage the app localization flow.

yarn

Now running yarn run or yarn build will engage the app localization flow.