onesky-conductor for Web

To streamline the app localization development flow, onesky-conductor retrieves string files via OneSky's App API and writes to user defined folder for the web app. It executes during app packing process. For more information, please refer to our Developer Hub.

Install

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

Usage

onesky-conductor --help

  Usage: onesky-conductor [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 --app-id ${ONESKY_APP_ID} --api-key ${ONESKY_API_KEY}

Adjust your npm-scripts

Define environment variables ONESKY_APP_ID and ONESKY_API_KEY under your project environment, for example,

export ONESKY_APP_ID=aa339d82-7365-406b-af92-f3d1f4c77651
export ONESKY_API_KEY=291878c9b5de3fbdf7bedff8570c3d68

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

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

Run

Under your app folder:

npm

If you use npm, run the following commands to engage the app localization flow:

# install
npm install

# run on local machine
npm start

# pack for production
npm run build

yarn

If you use yarn, run the following commands to engage the app localization flow:

# install
yarn

# run on local machine
yarn run

# pack for production
yarn build