$ flight-tracker

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations]

A flight tracker in your command line.

Coded in the airport and on the plane. ✈️

☁️ Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global flight-tracker

# Using yarn
yarn global add flight-tracker

Then, run flight-tracker --help and see what the CLI tool can do.

$ flight-tracker --help
Usage: flight-tracker <startDate> <endDate> <start> <end> [options]

A flight tracker in your command line.

Command arguments:
  <startDate>  The start date.
  <endDate>    The end date.
  <start>      The start location.
  <end>        The end location.

Options:
  -i, --interval <ms>     The interval value in milliseconds.
  -d, --decimals <count>  How many decimals to display.
  -v, --version           Displays version information.
  -h, --help              Displays this help.

Examples:
  $ flight-tracker '2016-05-26 18:05' '2016-05-26 21:15' 'Cluj-Napoca' 'Luton, London' -i 50 -d 20

Documentation can be found at https://github.com/M-R-D-G/flight-tracker#readme.

📋 Example

Here is an example how to use this package as library. To install it locally, as library, you can do that using npm (or yarn):

# Using npm
npm install --save flight-tracker

# Using yarn
yarn add flight-tracker

const flightTracker = require("flight-tracker");

// Actually, yeah, that was a real flight :D
flightTracker({
    // Where and when are you flying from?
    start: ["Cluj-Napoca", new Date(2016, 4, 26, 18, 5)]

    // Where and when are you flying to?
  , end: ["Luton, London", new Date(2016, 4, 26, 21, 15)]

    ///// The following are the defaults. You don't
    ///// have to provide them as long you are happy with them.

    // How often do you want to update the output?
  , interval: 50

    // Width of the stream
  , width: process.stdout.columns || 60

    // By default, show two decimals
  , decimals: 20

    // By default, use the standard out stream of the current process
  , stream: process.stdout
}).on("error", err => {
    console.error(err);
    process.exit(1);
});

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛

📝 Documentation

For full API reference, see the [DOCUMENTATION.md][docs] file.

😋 How to contribute

Have an idea? Found a bug? See [how to contribute][contributing].

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀
• [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. 😁 📖
• [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵
• [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

Thanks! ❤️