https://github.com/varnamproject/varnamd
Varnam daemon which also acts as a HTTP server. Deprecated. See https://github.com/varnamproject/varnamd-govarnam/
https://github.com/varnamproject/varnamd
Last synced: 5 months ago
JSON representation
Varnam daemon which also acts as a HTTP server. Deprecated. See https://github.com/varnamproject/varnamd-govarnam/
- Host: GitHub
- URL: https://github.com/varnamproject/varnamd
- Owner: varnamproject
- License: mit
- Created: 2014-10-29T04:46:03.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-11-28T12:04:21.000Z (over 5 years ago)
- Last Synced: 2024-06-19T18:09:30.799Z (about 2 years ago)
- Language: Go
- Homepage:
- Size: 207 KB
- Stars: 8
- Watchers: 6
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/golang/go/wiki/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:
```json
{
"success": true,
"error": "",
"at": "2020-07-02 11:10:30.309343848 +0000 UTC",
"result": [
"മലയാളം",
"മലയാലം",
"മലയാളം",
"മലായാളം",
"മലയളം",
"മ്മലയലം",
"മലയാളമാ",
"മലയാളമാദ്ധ്യമത്തിലൂ",
"മലയാളമാദ്ധ്യമത്തിലൂടെ",
"മലയാളമാദ്ധ്യമത്തിൽ",
"മലയാളമാദ്ധ്യമം"
],
"input": "Malayalam"
}
```
##### see server.go for supported APIs.