Skip to content

Commit 2f9382c

Browse files
authored
Merge pull request #233 from DeepLcom/add-nodejs-proxy-info
Add NodeJS proxy info
2 parents bc87326 + ab79163 commit 2f9382c

File tree

4 files changed

+44
-2
lines changed

4 files changed

+44
-2
lines changed

docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@
5757
"docs/learning-how-tos/cookbook/google-sheets",
5858
"docs/learning-how-tos/cookbook/automating-indie-game-localization-with-the-deepl-api-and-godot",
5959
"docs/learning-how-tos/cookbook/java-document-translator",
60-
"docs/learning-how-tos/cookbook/usage-analytics-dashboard"
60+
"docs/learning-how-tos/cookbook/usage-analytics-dashboard",
61+
"docs/learning-how-tos/cookbook/nodejs-proxy"
6162
]
6263
},
6364
{

docs/best-practices/cors-requests.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ If you realize your API authentication key has been compromised, log in to your
1111

1212
To safely use the DeepL API on your website or application, you can route your requests through your own backend servers. This keeps your credentials hidden and allows you to specify CORS policies and rate limits as required by your use case.
1313

14-
DeepL's official open-source [client libraries](/docs/getting-started/client-libraries) can help you create these backend implementations.
14+
DeepL's official open-source [client libraries](/docs/getting-started/client-libraries) can help you create these backend implementations. For prototyping and frontend testing, you can use the [DeepL API Node.js Proxy](https://github.com/DeepLcom/deepl-api-nodejs-proxy/), a lightweight ready-to-use proxy server that handles CORS and keeps your API key secure.

docs/learning-how-tos/cookbook.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,9 @@ public: true
3434

3535
Updated on 2025-12-17
3636
</Card>
37+
<Card title="Node.js Proxy Server" icon="server" href="/docs/learning-how-tos/cookbook/nodejs-proxy">
38+
A ready-to-use proxy server for secure browser-based API calls
39+
40+
Updated on 2024-10-30
41+
</Card>
3742
</CardGroup>
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "Node.js Proxy Server"
3+
description: "A lightweight local proxy for the DeepL API that enables browser-based applications to bypass CORS restrictions."
4+
public: true
5+
---
6+
7+
<Card title="GitHub - DeepLcom/deepl-api-nodejs-proxy" icon="github" horizontal href="https://github.com/DeepLcom/deepl-api-nodejs-proxy">
8+
DeepL API Node.js Proxy on GitHub
9+
</Card>
10+
11+
12+
## Overview
13+
14+
This lightweight proxy server lets you call the DeepL API directly from browser-based applications. In simpler terms, it lets you make DeepL API calls from your client-side JavaScript without running into browser security restrictions.
15+
16+
Since the DeepL API doesn't allow direct browser requests (see [CORS requests documentation](/docs/best-practices/cors-requests)), this proxy handles CORS headers and keeps your API key secure. Perfect for hackathons, demos, and quick prototypes where you need to get up and running fast.
17+
18+
Built with Node.js and Express with minimal dependencies. Supports all DeepL API endpoints including text translation, document translation, and glossaries. Includes an interactive web demo for testing translations right in your browser.
19+
20+
<Note>
21+
This proxy is intended for prototyping and frontend testing. For production environments, consider implementing your own backend service with additional security measures and rate limiting.
22+
</Note>
23+
24+
## Quick Start
25+
26+
The proxy includes an interactive setup wizard to get you started quickly. Clone the repo, run the setup, and start sending requests from your browser. Check out the [GitHub repository](https://github.com/DeepLcom/deepl-api-nodejs-proxy) for full setup instructions and Docker support.
27+
28+
## Screenshots
29+
30+
<Frame>
31+
<img src="https://raw.githubusercontent.com/DeepLcom/deepl-api-nodejs-proxy/main/assets/proxy-running.png" alt="Node.js proxy server running and ready to accept requests" />
32+
</Frame>
33+
34+
<Frame>
35+
<img src="https://raw.githubusercontent.com/DeepLcom/deepl-api-nodejs-proxy/main/assets/dashboard-demo.png" alt="Interactive web demo interface for testing translations" />
36+
</Frame>

0 commit comments

Comments
 (0)