README.md

varnamd

=============

Varnam daemon which also acts as a HTTP server. This program powers http://varnamproject.com

Installation

You do not have to git clone the repo. Use the following command to clone and install varnamd:

go get github.com/varnamproject/varnamd

You need to have set the $GOPATH environment variable for this to work. Do not worry about the directory structure since it will be created for you by the previous go get.

cd $GOPATH/src/github.com/varnamproject/varnamd

go install

The binaries should now be present in $GOPATH/bin/

./$GOPATH/bin/varnamd to run the server

Usage

varnamd supports the following command line arguments:

• p int. Run daemon in specified port
• max-handle-count int. Maximum number of handles can be opened for each language
• host string. Host for the varnam daemon server.
• ui string. UI directory path. Put your index.html here.
• enable-internal-apis boolean. Enable internal APIs
• enable-ssl boolean
• cert-file-path string. Certificate file path
• key-file-path string.
• upstream string. Provide an upstream server
• enable-download. string. Comma separated language identifier for which varnamd will download words from upstream
• sync-interval int.
• log-to-file boolean. If true, logs will be written to a file
• version

API

When a request is made to translate a word, say 'Malayalam',

Request URL: https://api.varnamproject.com/tl/{langCode}/{Word}

Request Method: GET

and the response for https://api.varnamproject.com/tl/ml/Malayalam will be:

{
  "success": true,
  "error": "",
  "at": "2020-07-02 11:10:30.309343848 +0000 UTC",
  "result": [
    "മലയാളം",
    "മലയാലം",
    "മലയാ‍ളം",
    "മലായാളം",
    "മലയളം",
    "മ്മലയലം",
    "മലയാളമാ",
    "മലയാളമാദ്ധ്യമത്തിലൂ",
    "മലയാളമാദ്ധ്യമത്തിലൂടെ",
    "മലയാളമാദ്ധ്യമത്തിൽ",
    "മലയാളമാദ്ധ്യമം"
  ],
  "input": "Malayalam"
}

see server.go for supported APIs.