Matsumura Rohai

Translate strings found in PO files

Background for the project name

The name for this project is honouring one great bushi, Matsumura Sokon, who lived in Okinawa, Japan, and a Karate Kata named after him.

Matsumura Sokon lived around ~1800 and was one very important contributor to the local martial art, which we today know as Karate and Ryukyu Kobujutsu. The kata named after him is called Matsumura Rohai, also known as Koshiki Rohai or Matsumura no Rohai, depending on who is writing it.

Getting started

The project provides a Node.js based server and a front-end for modifying translations. The back-end makes requests to the Microsoft Translate API and caches the received translations to a SQLite database.

Installation

While in Windows, different versions of Visual Studio might be problematic, thus failing iconv installation. With different options to --msvs_version, one might succeed. Such options are auto, 2010, 2012 and so forth.

npm install --msvs_version=2012

Please note that the minimum supported version of Node.js is 14.15.0, which is the active Long Term Support (LTS) version.

Usage

export MS_TRANSLATE_API_KEY=****
export MS_TRANSLATE_API_SECRET=****
node index.js

Third party tools

• jQuery taking care of the Ajax
• Bootstrap for making things look good by default
• Microsoft Translate API via mstranslator for node.js
• PO and MO file handling via node-gettext
• Express for making pages to route to certain methods
• Hogan.js for rendering client side templates

Project structure

Visualisation of the project dependencies is available at paazmaya.github.io/matsumura-rohai.

Contributing

"A Beginner's Guide to Open Source: The Best Advice for Making your First Contribution".

Also there is a blog post about "45 Github Issues Dos and Don’ts".

Linting is done with ESLint and can be executed with npm run lint. There should be no errors appearing after any JavaScript file changes.

License

Copyright (c) Juga Paazmaya paazmaya@yahoo.com

Licensed under the MIT license.