Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 3.31 KB

README.md

File metadata and controls

55 lines (33 loc) · 3.31 KB
Raw

Ten Percent

GitHub license Travis branch XO code style

Ten Percent (l10n percent) is a Node.js microservice which uses the Transifex REST API to retrieve the localization status of a given Transifex resource. I made Ten Percent so that I could use a Shields.io dynamic badge to display the localization status of the Pressbooks Open Source project's resources and encourage ongoing localization efforts. Hopefully others will find it useful for their projects as well.

Requirements

Setup

  1. Install the Vercel CLI on your device and log in to your Vercel account.

  2. Add your Transifex API token as a secret:

    vercel secrets add transifex-api-token "<TOKEN>"

  3. Deploy greatislander/tenpercent to Vercel. Be sure to assign the secret you created in step 2 to the TRANSIFEX_API_TOKEN environment variable:

    vercel greatislander/tenpercent -e TRANSIFEX_API_TOKEN=@transifex-api-token

Usage

  1. Visit your Vercel deploy, supplying the query parameters for organization, project, and optionally resource (resource defaults to 0, the first resource by numeric index; if the project has multiple resources, you can select the appropriate one by supplying a different value). Verify that the resulting JSON object reflects the localization status of the desired resource (a numeric value corresponding to the percentage translated):

    $ curl 'https://<SUBDOMAIN>.vercel.app?organization=<ORGANIZATION>&project=<PROJECT>[&resource=<RESOURCE INDEX>]'
{"status":"10"}

    If the API token is missing or invalid or if you have specified a non-existent Transifex organization, project or resource, you will see an error message.

  2. Use the URL you determined in step 1 to generate a Shields.io dynamic badge that shows the localization status of your Transifex project. You'll need to set the data type to JSON and the query to $.status.

    https://img.shields.io/badge/dynamic/json.svg?url=<URL>&label=translated&query=$.status.&colorB=<COLOR>&prefix=<PREFIX>&suffix=%25

    This URL will produce the following badge layout with the example response in step 1:

    Example Badge

    Now you can add a badge to your GitHub readme which will reflect the current localization status of your project.

Notes

Responses from the Transifex REST API are cached for 24 hours to prevent excessive API calls, so you may not see the changes immediately.

Related Work