Skip to content

uhIgnacio-zz/lingva-translate

 
 

Repository files navigation

Lingva Translate

Travis Build Vercel Status Cypress Tests License Awesome Humane Tech

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 NewPipe, Nitter, Invidious or Bibliogram, Lingva scrapes through GTranslate and retrieves the translation without using any Google-related service, preventing them from tracking.

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

  • TypeScript, the JavaScript superset, as the language.
  • React as the main front-end framework.
  • NextJS as the complementary React framework, that provides Server-Side Rendering, Static Site Generation or serverless API endpoints.
  • ChakraUI for the in-component styling.
  • Jest, Testing Library & Cypress for unit, integration & E2E testing.
  • Apollo Server for handling the GraphQL endpoint.
  • Inkscape for designing both the logo and the banner.

Deployment

As Lingva is a NextJS project you can deploy your own instance anywhere Next is supported.

The only requerement 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.

The easiest way is to use their creators' own platform, Vercel, where you can deploy it for free with the following button.

Deploy with Vercel

There's also an official Docker image available for easing the deployment using Compose, Kubernetes or similar technologies. Remember to also include the environment variable (simplified to site_domain) when running the container.

docker run -p 3000:3000 -e site_domain=lingva.ml thedaviddelta/lingva-translate:latest

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

Domain Hosting SSL Provider
lingva.ml (Official) Vercel Let's Encrypt
translate.alefvanoon.xyz Vercel Let's Encrypt
translate.igna.rocks Vercel Let's Encrypt

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
{
    translation: string
}
  • GET /api/v1/audio/:lang/:query
{
    audio: number[]
}
  • GET /api/v1/languages/?:(source|target)
{
    languages: [
        {
            code: string,
            name: string
        }
    ]
}

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

{
    error: string
}

GraphQL API

  • /api/graphql
query {
    translation(source: String target: String query: String!) {
        source: {
            lang: {
                code: String!
                name: String!
            }
            text: String!
            audio: [Int]!
        }
        target: {
            lang: {
                code: String!
                name: String!
            }
            text: String!
            audio: [Int]!
        }
    }
    audio(lang: String! query: String!) {
        lang: {
            code: String!
            name: String!
        }
        text: String!
        audio: [Int]!
    }
    languages(type: SOURCE|TARGET) {
        code: String!
        name: String!
    }
}

Contributors

Thanks goes to these wonderful people (emoji key):


David

️️️️♿️ 💻 📖 🎨 ⚠️

Mohammed Anas

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Copyright © 2021 TheDavidDelta & contributors.
This project is GNU AGPLv3 licensed.

About

Alternative front-end for Google Translate

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 99.3%
  • Dockerfile 0.7%