thedaviddelta/lingva-translate

Lingva Translate

https://travis-ci.com/thedaviddelta/lingva-translate.svg?branch=main](https://travis-ci.com/thedaviddelta/lingva-translate) https://img.shields.io/github/deployments/thedaviddelta/lingva-translate/Production?label=vercel&logo=vercel&color=f5f5f5]([***] https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/qgjdyd&style=flat&logo=cypress](https://dashboard.cypress.io/projects/qgjdyd/runs) https://img.shields.io/github/license/thedaviddelta/lingva-translate](https://github.com/thedaviddelta/lingva-translate/blob/main/LICENSE) https://raw.githubusercontent.com/humanetech-community/awesome-humane-tech/main/humane-tech-badge.svg?sanitize=true](https://github.com/humanetech-community/awesome-humane-tech) https://vercel.com?utm_source=lingva-team&utm_campaign=oss

Alternative front-end for Google Translate, serving as a Free and Open Source translator with over a hundred languages available

How does it work?

Inspired by projects like https://github.com/TeamNewPipe/NewPipe, https://github.com/***, https://github.com/iv-org/invidious or https://git.sr.ht/~cadence/bibliogram, Lingva scrapes through Google Translate and retrieves the translation without directly accessing any Google-related service, preventing them from tracking.

For this purpose, Lingva is built, among others, with the following Open Source resources:

• https://github.com/thedaviddelta/lingva-scraper, a Google Translate scraper built and maintained specifically for this project, which obtains all kind of information from this platform.
• https://www.typescriptlang.org/, the JavaScript superset, as the language.
• https://reactjs.org/ as the main front-end framework.
• https://nextjs.org/ as the complementary React framework, that provides Server-Side Rendering, Static Site Generation or serverless API endpoints.
• https://chakra-ui.com/ for the in-component styling.
• https://jestjs.io/, Testing Library & https://www.cypress.io/ for unit, integration & E2E testing.
• Apollo Server for handling the GraphQL endpoint.
• https://inkscape.org/ for designing both the logo and the banner.

Deployment

As Lingva is a https://nextjs.org/ project you can deploy your own instance anywhere Next is supported.

The only requirement is to set an environment variable called NEXT_PUBLIC_SITE_DOMAIN with the domain you're deploying the instance under. This is used for the canonical URL and the meta tags.

Optionally, there are other environment variables available:

• NEXT_PUBLIC_FORCE_DEFAULT_THEME: Force a certain theme over the system preference set by the user. The accepted values are light and dark.
• NEXT_PUBLIC_DEFAULT_SOURCE_LANG: Set an initial source language instead of the default auto.
• NEXT_PUBLIC_DEFAULT_TARGET_LANG: Set an initial target language instead of the default en.

Docker

An https://hub.docker.com/r/thedaviddelta/lingva-translate is available to ease the deployment using Compose, Kubernetes or similar technologies. Remember to also include the environment variables (simplified to site_domain, force_default_theme, default_source_lang and default_target_lang) when running the container.

Docker Compose:

version: '3'

services:

  lingva:
    container_name: lingva
    image: thedaviddelta/lingva-translate:latest
    restart: unless-stopped
    environment:
      - site_domain=lingva.ml
      - force_default_theme=light
      - default_source_lang=auto
      - default_target_lang=en
    ports:
      - 3000:3000

Docker Run

bash
docker run -p 3000:3000 -e site_domain=lingva.ml -e force_default_theme=light -e default_source_lang=auto -e default_target_lang=en thedaviddelta/lingva-translate:latest

Vercel

Another easy way is to use the Next.js creators' own platform, https://vercel.com/, where you can deploy it for free with the following button.

https://vercel.com/button](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fthedaviddelta%2Flingva-translate%2Ftree%2Fmain&env=NEXT_PUBLIC_SITE_DOMAIN&envDescription=Your%20domain&utm_source=lingva-team&utm_campaign=oss)

Instances

These are the currently known Lingva instances. Feel free to make a Pull Request including yours (please remember to add [skip ci] to the last commit).

Public APIs

Nearly all the Lingva instances should supply a pair of public developer APIs: a RESTful one and a GraphQL one.

Note: both APIs return the translation audio as a Uint8Array (served as number[] in JSON and [Int] in GraphQL) with the contents of the audio buffer.

REST API v1

• GET /api/v1/:source/:target/:query

typescript
{
    translation: string
    info?: TranslationInfo
}

• GET /api/v1/audio/:lang/:query

typescript
{
    audio: number[]
}

• GET /api/v1/languages/?:(source|target)

typescript
{
    languages: [
        {
            code: string,
            name: string
        }
    ]
}

In addition, every endpoint can return an error message with the following structure instead.

typescript
{
    error: string
}

GraphQL API

• /api/graphql

graphql
query {
    translation(source: String target: String query: String!) {
        source: {
            lang: {
                code: String!
                name: String!
            }
            text: String!
            audio: [Int]!
            detected: {
                code: String
                name: String
            }
            typo: String
            pronunciation: String
            definitions: {
                type: String
                list: {
                    definition: String
                    example: String
                    field: String
                    synonyms: [String]
                }
            }
            examples: [String]
            similar: [String]
        }
        target: {
            lang: {
                code: String!
                name: String!
            }
            text: String!
            audio: [Int]!
            pronunciation: String
            extraTranslations: {
                type: String
                list: {
                    word: String
                    article: String
                    frequency: Int
                    meanings: [String]
                }
            }
        }
    }
    audio(lang: String! query: String!) {
        lang: {
            code: String!
            name: String!
        }
        text: String!
        audio: [Int]!
    }
    languages(type: SOURCE|TARGET) {
        code: String!
        name: String!
    }
}

Related projects

• https://github.com/thedaviddelta/lingva-scraper - Google Translate scraper built and maintained specifically for this project
• https://codeberg.org/SimpleWeb/SimplyTranslate-Web - Very simple translation front-end with multi-engine support
• https://github.com/LibreTranslate/LibreTranslate - FOSS translation service that uses the open https://github.com/argosopentech/argos-translate engine
• https://github.com/yaxarat/lingvaandroid - Unofficial native client for Android that uses Lingva's public API
• https://github.com/MahanRahmati/translate - Unofficial cross-platform native client that uses Lingva's public API
• https://github.com/walking-oct***/translate-ut - Unofficial native client for Ubuntu Touch that uses Lingva's public API

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the https://github.com/all-contributors/all-contributors specification. Contributions of any kind welcome!

License

https://www.gnu.org/graphics/agplv3-with-text-162x68.png](https://www.gnu.org/licenses/agpl-3.0.html)

Copyright © 2021 https://github.com/thedaviddelta & contributors.
This project is https://github.com/thedaviddelta/lingva-translate/blob/main/LICENSE licensed.