djinn-anthrope / apertium-html-tools

Apertium Html-tools is a web application providing a fully localised interface for text/document translation, analysis and generation powered by Apertium.

Apertium Html-tools

Apertium Html-tools is a web application providing a fully localised interface for text/document/website translation, analysis, and generation powered by Apertium. Designed with a dead simple build process, minimal dependencies and only static resources for quick and easy deployment with any web server, it is relatively lightweight and user-friendly. Html-tools relies on an Apertium HTTP API such as Apertium-apy or ScaleMT (to a lesser extent). Development takes place on GitHub; however, a read-only copy of the repository is kept in our SVN repository (/trunk/apertium-tools/apertium-html-tools).

More information along with instructions for localization is available on the Apertium Wiki.

Prerequisites

• Python 3
• curl

Setup

1. Copy config.conf.example to config.conf and edit it.
2. Then type make.

Running

The static files within /build (generated by make) can be served by any server. You can use whatever you like, including Apache or even just Python's HTTP server. For example, to run on locally on http://localhost:8080 you can do the following:

python3 -m http.server 8080

A completely local setup with language data and translation from Apertium, an APy instance, and Nginx to serve Html-tools is provided through Docker. After installing Docker, simply run the following and check http://localhost:4545. Any changes to the local version of Html-tools will trigger a make.

docker-compose up

For production usage, remember to enable gzip compression in your server.

Contributing

CircleCI runs tests and generates build artifacts including a live copy of Html-tools using config.conf.example.