2021-03-28 23:41:56 +02:00
# Lingva Translate
2021-03-09 20:02:40 +01:00
2021-06-12 22:44:56 +02:00
<img src="public/logo.svg" width="128" align="right">
2021-03-28 23:32:39 +02:00
2022-06-15 23:37:15 +02:00
[](https://travis-ci.com/thedaviddelta/lingva-translate)
[](https://lingva.ml/)
2021-05-08 02:01:51 +02:00
[](https://dashboard.cypress.io/projects/qgjdyd/runs)
2022-06-15 23:37:15 +02:00
[](./LICENSE)
2021-04-30 23:11:26 +02:00
[](https://github.com/humanetech-community/awesome-humane-tech)
2022-01-23 23:30:36 +01:00
[<img src="https://www.datocms-assets.com/31049/1618983297-powered-by-vercel.svg" alt="Powered by Vercel" height="20"> ](https://vercel.com?utm_source=lingva-team&utm_campaign=oss )
2021-03-28 23:41:56 +02:00
Alternative front-end for Google Translate, serving as a Free and Open Source translator with over a hundred languages available
## How does it work?
2022-06-15 23:37:15 +02:00
Inspired by projects like [NewPipe ](https://github.com/TeamNewPipe/NewPipe ), [Nitter ](https://github.com/zedeus/nitter ), [Invidious ](https://github.com/iv-org/invidious ) or [Bibliogram ](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.
2021-03-28 23:41:56 +02:00
For this purpose, * Lingva * is built, among others, with the following Open Source resources:
2022-06-15 23:37:15 +02:00
+ [Lingva Scraper ](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.
2021-03-28 23:41:56 +02:00
+ [TypeScript ](https://www.typescriptlang.org/ ), the JavaScript superset, as the language.
+ [React ](https://reactjs.org/ ) as the main front-end framework.
2022-01-24 00:53:52 +01:00
+ [Next.js ](https://nextjs.org/ ) as the complementary React framework, that provides Server-Side Rendering, Static Site Generation or serverless API endpoints.
2021-03-28 23:41:56 +02:00
+ [ChakraUI ](https://chakra-ui.com/ ) for the in-component styling.
+ [Jest ](https://jestjs.io/ ), [Testing Library ](https://testing-library.com/ ) & [Cypress ](https://www.cypress.io/ ) for unit, integration & E2E testing.
+ [Apollo Server ](https://www.apollographql.com/docs/apollo-server/ ) for handling the GraphQL endpoint.
+ [Inkscape ](https://inkscape.org/ ) for designing both the logo and the banner.
## Deployment
2022-01-24 00:53:52 +01:00
As * Lingva * is a [Next.js ](https://nextjs.org/ ) project you can deploy your own instance anywhere Next is supported.
2021-03-28 23:41:56 +02:00
2021-10-24 11:49:40 +00:00
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.
2021-03-28 23:41:56 +02:00
2022-06-15 23:37:15 +02:00
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` .
2021-10-24 16:08:35 +02:00
2021-10-24 11:49:40 +00:00
### Docker
2021-03-28 23:41:56 +02:00
2022-06-15 23:37:15 +02:00
An [official Docker image ](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.
2021-10-24 11:49:40 +00:00
#### Docker Compose:
```
version: '3'
services:
lingva:
container_name: lingva
image: thedaviddelta/lingva-translate:latest
restart: unless-stopped
environment:
- site_domain=lingva.ml
2022-06-15 23:37:15 +02:00
- force_default_theme=light
2022-02-24 19:53:31 +01:00
- default_source_lang=auto
- default_target_lang=en
2021-10-24 11:49:40 +00:00
ports:
- 3000:3000
```
2021-03-28 23:41:56 +02:00
2021-10-24 11:49:40 +00:00
#### Docker Run
2021-09-05 16:44:05 +02:00
```bash
2022-06-15 23:37:15 +02:00
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
2021-09-05 16:44:05 +02:00
```
2021-10-24 11:49:40 +00:00
### Vercel
2022-01-24 00:53:52 +01:00
Another easy way is to use the Next.js creators' own platform, [Vercel ](https://vercel.com/ ), where you can deploy it for free with the following button.
2021-10-24 11:49:40 +00:00
2022-06-15 23:37:15 +02:00
[](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)
2021-10-24 11:49:40 +00:00
2021-03-28 23:41:56 +02:00
## Instances
2021-05-08 02:01:51 +02:00
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).
2022-06-26 21:03:23 +02:00
| Domain | Hosting | SSL Provider |
|:---------------------------------------------------------------------------:|:-----------------------------------------:|:-----------------------------------------------------------------------------------------------:|
| [lingva.ml ](https://lingva.ml/ ) (Official) | [Vercel ](https://vercel.com/ ) | [Let's Encrypt ](https://www.ssllabs.com/ssltest/analyze.html?d=lingva.ml ) |
2022-11-02 12:15:27 -03:00
| [translate.igna.wtf ](https://translate.igna.wtf/ ) | [Vercel ](https://vercel.com/ ) | [Let's Encrypt ](https://www.ssllabs.com/ssltest/analyze.html?d=translate.igna.wtf ) |
2022-06-26 21:03:23 +02:00
| [translate.plausibility.cloud ](https://translate.plausibility.cloud/ ) | [Hetzner ](https://hetzner.com/ ) | [Let's Encrypt ](https://www.ssllabs.com/ssltest/analyze.html?d=translate.plausibility.cloud ) |
2023-01-13 17:53:04 +01:00
| [lingva.lunar.icu ](https://lingva.lunar.icu/ ) | [Lansol ](https://lansol.de/ ) | [Cloudflare ](https://www.ssllabs.com/ssltest/analyze.html?d=lingva.lunar.icu ) |
2022-07-26 14:30:58 +02:00
| [translate.projectsegfau.lt ](https://translate.projectsegfau.lt/ ) | Self-hosted | [Let's Encrypt ](https://www.ssllabs.com/ssltest/analyze.html?d=translate.projectsegfau.lt ) |
2023-01-13 17:53:04 +01:00
| [translate.dr460nf1r3.org ](https://translate.dr460nf1r3.org/ ) | [Netcup ](https://netcup.eu/ ) | [Cloudflare ](https://www.ssllabs.com/ssltest/analyze.html?d=translate.dr460nf1r3.org ) |
| [lingva.garudalinux.org ](https://lingva.garudalinux.org/ ) | [Hetzner ](https://hetzner.com/ ) | [Cloudflare ](https://www.ssllabs.com/ssltest/analyze.html?d=lingva.garudalinux.org ) |
2022-10-09 21:36:33 +02:00
| [translate.jae.fi ](https://translate.jae.fi/ ) | Self-hosted | [Let's Encrypt ](https://www.ssllabs.com/ssltest/analyze.html?d=translate.jae.fi ) |
2022-07-26 11:34:46 +00:00
2021-05-08 02:01:51 +02:00
2021-03-28 23:41:56 +02:00
## 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
2021-04-01 15:40:25 +02:00
+ GET `/api/v1/:source/:target/:query`
2021-03-28 23:41:56 +02:00
```typescript
{
2021-08-30 21:35:22 +02:00
translation: string
2022-06-15 23:37:15 +02:00
info?: TranslationInfo
2021-03-28 23:41:56 +02:00
}
```
2021-04-01 15:40:25 +02:00
+ GET `/api/v1/audio/:lang/:query`
2021-03-28 23:41:56 +02:00
```typescript
{
2021-08-30 21:35:22 +02:00
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
2021-03-28 23:41:56 +02:00
}
```
### GraphQL API
+ `/api/graphql`
```graphql
query {
translation(source: String target: String query: String!) {
source: {
2021-08-30 21:35:22 +02:00
lang: {
code: String!
name: String!
}
text: String!
audio: [Int]!
2022-06-15 23:37:15 +02:00
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]
2021-03-28 23:41:56 +02:00
}
target: {
2021-08-30 21:35:22 +02:00
lang: {
code: String!
name: String!
}
text: String!
audio: [Int]!
2022-06-15 23:37:15 +02:00
pronunciation: String
extraTranslations: {
type: String
list: {
word: String
article: String
frequency: Int
meanings: [String]
}
}
2021-03-28 23:41:56 +02:00
}
}
2021-04-01 15:40:25 +02:00
audio(lang: String! query: String!) {
2021-08-30 21:35:22 +02:00
lang: {
code: String!
name: String!
}
text: String!
audio: [Int]!
}
languages(type: SOURCE|TARGET) {
code: String!
name: String!
2021-03-28 23:41:56 +02:00
}
}
```
2022-01-19 17:13:43 +01:00
## Related projects
2022-06-15 23:37:15 +02:00
+ [Lingva Scraper ](https://github.com/thedaviddelta/lingva-scraper ) - Google Translate scraper built and maintained specifically for this project
+ [SimplyTranslate ](https://codeberg.org/SimpleWeb/SimplyTranslate-Web ) - Very simple translation front-end with multi-engine support
2022-01-19 17:13:43 +01:00
+ [LibreTranslate ](https://github.com/LibreTranslate/LibreTranslate ) - FOSS translation service that uses the open [Argos ](https://github.com/argosopentech/argos-translate ) engine
+ [Lentil for Android ](https://github.com/yaxarat/lingvaandroid ) - Unofficial native client for Android that uses Lingva's public API
2022-06-15 23:37:15 +02:00
+ [Arna Translate ](https://github.com/MahanRahmati/translate ) - Unofficial cross-platform native client that uses Lingva's public API
+ [Translate-UT ](https://github.com/walking-octopus/translate-ut ) - Unofficial native client for Ubuntu Touch that uses Lingva's public API
2022-01-19 17:13:43 +01:00
2021-03-28 23:41:56 +02:00
## Contributors
2021-03-28 23:32:39 +02:00
Thanks goes to these wonderful people ([emoji key ](https://allcontributors.org/docs/en/emoji-key )):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://thedaviddelta.com/"><img src="https://avatars.githubusercontent.com/u/6679900?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David</b></sub></a><br /><a href="#a11y -TheDavidDelta" title="Accessibility">️️️️♿️</a> <a href="https://github.com/TheDavidDelta/lingva-translate/commits?author=TheDavidDelta" title="Code">💻</a> <a href="https://github.com/TheDavidDelta/lingva-translate/commits?author=TheDavidDelta" title="Documentation">📖</a> <a href="#design -TheDavidDelta" title="Design">🎨</a> <a href="https://github.com/TheDavidDelta/lingva-translate/commits?author=TheDavidDelta" title="Tests">⚠️</a></td>
2021-08-28 16:14:12 +02:00
<td align="center"><a href="https://github.com/mhmdanas"><img src="https://avatars.githubusercontent.com/u/32234660?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mohammed Anas</b></sub></a><br /><a href="https://github.com/TheDavidDelta/lingva-translate/commits?author=mhmdanas" title="Code">💻</a></td>
2021-10-24 13:51:08 +02:00
<td align="center"><a href="https://PussTheCat.org/"><img src="https://avatars.githubusercontent.com/u/47571719?v=4?s=100" width="100px;" alt=""/><br /><sub><b>TheFrenchGhosty</b></sub></a><br /><a href="https://github.com/TheDavidDelta/lingva-translate/commits?author=TheFrenchGhosty" title="Documentation">📖</a></td>
2021-03-28 23:32:39 +02:00
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
2021-03-28 23:41:56 +02:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
## License
[](https://www.gnu.org/licenses/agpl-3.0.html)
2022-06-15 23:37:15 +02:00
Copyright © 2021 [thedaviddelta ](https://github.com/thedaviddelta ) & contributors.
2021-03-28 23:41:56 +02:00
This project is [GNU AGPLv3 ](./LICENSE ) licensed.
