Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.62 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.62 KB
Raw

OpenTutor - a service for compiling user dictionaries and learning foreign words

A simple open-source kotlin-ktor web-application for compiling custom dictionaries and learning foreign words through flashcards.

It is now available via https://storage.yandexcloud.net/opentutor/index.html & https://opentutor.zapto.org

Edit dictionaries:

edit dictionary

Run flashcards:

run flashcards

Summary:

It is supposed to be an extended analogue of the desktop program Lingvo Tutor, which is a component of well-known ABBYY Lingvo.

The application is also available as a docker image (standalone version). The userdata with built-in dictionaries is stored in the /userdata directory (inside container), this allows to use docker volumes. By default, espeak-ng is used as Text-To-Speech service (it is pre-installed inside sszuev/ubuntu-jammy-openjdk-17-espeak-ng image).
To use voicerss TTS service (better quality) obtain API-key and specify it as an environment variable VOICERSS-KEY, e.g. docker run ... -e VOICERSS-KEY=${your-key} ...

Requirements (for dev):

  • java-17+
  • gradle-7+
  • docker

Build and run:

  • standalone version $ docker pull sszuev/open-tutor-standalone:latest && docker run --name open-tutor-standalone-app -p 8080:8080 sszuev/open-tutor-standalone:latest
  • prod version tutor-deploy/README
  • for additional info see app-ktor/README

License:

  • Apache License Version 2.0