Code Monkey home page Code Monkey logo

cors-server's Introduction

CORS-Anywhere Server

CORS-Anywhere is a Node.js package that adds CORS headers to a proxied request. This is useful when the API provider does not natively support CORS. Without altering the headers, a request to such a provider would cause an error and prevent the request from being fulfilled.

Tip: You can test out the server in this repo locally by using port 3000 in your application and prepending https://private-cors-server.herokuapp.com/ to your API request like this. However, if you want to use for a hosted website, then follow the implementation steps below.

Implementation

Implementation of a basic CORS-Anywhere server is very straightforward. Simply do the following:

  1. Clone or fork this repository.
  2. Within server.js, replace the website string in the originWhitelist array with the web address(es) that you want to authorise. You can keep the first string here as is for local testing (assuming you're using port 3000).
  3. Now simply upload / push the repo to a hosting provider. I used a free Heroku account to create a Node.js app. This can be done without any knowledge of Node, and only a basic familiarity with Git and the command line. Just follow the excellent documentation here (steps 3 to 6 inclusive can be ignored).
  4. Prepend the API request in your application code with the server URL as generated in the previous step like so. That's it, you've implemented the server!

Tip: If hosting on Heroku, a Procfile has already been created in this repository. This instructs the Heroku Node app on how to start the server.

Note: Heroku's acceptable use policy forbids the use of an open proxy (see part 6, item XVIII). Therefore, make sure to follow point 2 above. Leaving the array empty authorises all requests and therefore violates the AUP.

cors-server's People

Contributors

isoaxe avatar biguncleyemi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.