jichan.org
/
tatoeba-api-node
Arquivado
1
0
Derivar 0
Código Questões Pacotes Planeamentos Lançamentos Wiki Trabalho
Want to contribute? Fork me on Codeberg.org!
A proxy of the Tatoeba API with no CORS restrictions. https://jichan.org/api/tatoeba
Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
Este repositório está arquivado. Pode ver os seus ficheiros e cloná-lo, mas não pode fazer envios para o repositório nem lançar questões ou fazer pedidos de integração.
13 Cometimentos
1 Ramo
0 Etiquetas
58 KiB
 
Ramos Etiquetas
${ item.name }
Criar etiqueta ${ searchTerm }
Criar ramo ${ searchTerm }
de 'main'
${ noResults }
Ir para o ficheiro
Elnu 5896f27c44
Update repository links 		há 1 ano
.gitignore Ignore nginx config file há 2 anos
LICENSE Create LICENSE há 2 anos
README.md Create README.md há 2 anos
ecosystem.config.js Add PM2 ecosystem file há 2 anos
index.js Remove unused testing term variable há 2 anos
package-lock.json Downgrade to node-fetch v2, latest doesn't support require há 2 anos
package.json Update repository links há 1 ano

README.md

tatoeba-api

A proxy of the Tatoeba API with no CORS restrictions.

The only Tatoeba API currently has an issue where it's CORS policy blocks it from being used by JavaScript in the browser. This is a mirror of the Tatoeba API that has Access-Control-Allow-Origin: * set to circumvent this issue. I am hosting this at tatoeba.elnu.com until Tatoeba has a proper API implementation.

Usage

For information about API usage, see the official documentation.

This API mirror is a mirror of https://tatoeba.org/eng/api_v0/search. So, for example, https://tatoeba.org/en/api_v0/search?query=dog can be rewritten to https://tatoeba.elnu.com/?query=dog if you are using the version of the API I am hosting. For self-hosting, see Self-hosting.

Self-hosting

tatoeba-api requires Node.js and npm.

Install the depenedencies:

npm i

Running

Run tatoeba-api at port 3000 (the default):

node index.js

Run tatoeba-api at port 5000:

node index.js 5000

Running as background process

tatoeba-api can be easily run as a background process using pm2.

Install pm2:

npm i pm2 -g

The configuration for pm2 is stored in ecosystem.config.js, which by default sets it to run at port 5000 instead of 3000. To change the port, open this file and change the args field.

Start process:

pm2 start

For running starting the API at boot and more, see the pm2 documentation.