-
Notifications
You must be signed in to change notification settings - Fork 2
Add NodeJS proxy info #233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
|
||
|
|
||
| This lightweight proxy server lets you call the DeepL API directly from browser-based applications during prototyping and frontend testing. 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. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you want to add a line like "It lets you make DeepL API calls from your client-side JavaScript." just for people who might not understand the previous language?
| <img src="https://raw.githubusercontent.com/DeepLcom/deepl-api-nodejs-proxy/main/assets/dashboard-demo.png" alt="Interactive web demo interface for testing translations" /> | ||
| </Frame> | ||
|
|
||
| ## Quick Start |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want to put this part above the screenshots? That will make it easier to discover!
| 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. | ||
|
|
||
| DeepL's official open-source [client libraries](/docs/getting-started/client-libraries) can help you create these backend implementations. | ||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you want to bump this new language up, say, to become a new second paragraph? More people might see it then. Or you could give this section its own subheader. Perhaps best to add a reminder that this isn't really intended for production use (although I'd guess it could handle many such cases)
Adds links and info about our new open source NodeJS proxy