Web application providing a fully localised interface for text/website/document translation, analysis and generation powered by Apertium.
JavaScript CSS Python Makefile HTML Shell Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci s/npm/yarn Apr 4, 2018
assets Update tur localizations (#322) Aug 3, 2018
flow-typed Add TRANSLATION_CHAINING to flow config Mar 20, 2018
tools
.dockerignore
.flowconfig Improvements to Flow coverage Dec 20, 2017
.gitattributes
.gitignore Move dev deps into package.json Apr 4, 2018
.hound.yml Switch to sass-lint from scss-lint Jun 19, 2017
.htmlhintrc.json
COPYING
Dockerfile Update Dockerfile and use APy dockerfile from source Apr 26, 2018
Makefile Bump a couple of missed deps Apr 30, 2018
README.md
config.conf.example
debug-head.html
docker-compose.yml
flow-coverage.json Improvements to Flow coverage Dec 20, 2017
index.html.in Displays translation options correctly in one line (fixes #246) Jun 18, 2018
isobork more codes May 4, 2014
not-found.html Not found error page as alert Jul 15, 2014
package.json Move dev deps into package.json Apr 4, 2018
prod-head.html
requirements-dev.txt
requirements-prod.txt
sitemap.xml.in
yarn.lock

README.md

Apertium Html-tools

CircleCI

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).

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:8082 you can do the following.

python3 -m http.server 8082

A completely local setup with language data and translation from Apertium, an APy instance, and Nginx to serve Html-tools is provided via Docker. After installing Docker, point your APY_URL in config.conf to http://localhost:2737, run the following, and check http://localhost:8082. Any changes to the local version of Html-tools will trigger a make.

docker-compose up

For production usage, remember to

  1. Build with jsmin, csscompressor and htmlmin using pip install -r requirements-prod.txt.
  2. Enable gzip compression on your server.

Contributing

Run pip install -r requirements-dev.txt to get development dependencies.

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