/jsonp-1

A simple JSON proxy

Primary LanguageJavaScriptMIT LicenseMIT

JSONProxy Build Status

Simple HTTP proxy that enables cross-domain requests to any JSON API. See https://jsonp.afeld.me for documentation. See the releases page for the client library changelog.

Setup

Simple

See package.json for compatible Node versions.

npm install
npm start

and do requests to http://localhost:8000/?url=.... For live reloading:

npm install -g nodemon
export $(cat .env | xargs) && nodemon

External services

The following service integrations can be enabled with the corresponding envrionment variables:

  • New Relic: set NEW_RELIC_LICENSE_KEY
  • Keen.io: set KEEN_PROJECT_ID and KEEN_WRITE_KEY

Deploy

Docker

This is how JSONProxy is deployed to production, so running locally with this setup will be more realistic.

Development

  1. If you don't have Docker set up already, follow their Get Started instructions.
  2. Start a Docker Quickstart Terminal.
  3. Run touch .env
    • Optionally fill out with environment variables specified above.
  4. Start the server with docker-compose up.
    • If you make a change and need to re-build, just press CTRL-c and run again.
  5. Open in the browser by running open http://$(docker-machine ip default).

Deployment

This app is deployed to Hyper.sh. To deploy, run

./bin/deploy

See also