1.0.3 • Published 7 years ago

flightaware.js v1.0.3

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
7 years ago

flightaware.js - Node.js RESTful API for FlightAware.com

Build Status NPM Version Coverage

This is a Javascript/Node.js based wrapper which simplifies communication with the FlightAware.com RESTful APIs. Documentation for the APIs can be found at: http://flightaware.com/commercial/flightxml/explorer

In order to use these APIs, you'll need to be a commercial subscriber to the FlightAware.com service, have a user name, and an API key.

FlightAware.com API access

In order to use the flightaware.js module, you'll need to have FlightAware username and api_key. You can get these from http://flightaware.com/commercial/flightxml. Note, that you'll need to sign up for the service. There is a free tier of service, but not all of the APIs are supported and the unit tests, described below, may fail.

You can find an example of how to use flightaware.js with AngularJS/node/express/bootstrap here.

AngularJS/flightaware.js example screenshot

Installation

Install this module using npm.

npm install flightaware.js

Unit testing

In order to unit test the flightaware.js module, you will need to check out the flightaware.js sources and create a file called config.js in the flightaware.js source tree.

Get the flightaware.js sources

git clone https://github.com/icedawn/flightaware.js
cd flightaware.js

Setting up config.js for unit testing

cat > config.js << EOF
module.exports = {
    username : 'your-flightaware-username',
    apiKey :   'your-flightaware-api-key'
};
EOF

Running the unit tests

node test.js