Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.25 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.25 KB
Raw

Enricher Component

TODO introduction...

Setup

To set this up you'll need the following:

  • A Redis Stack database. Get a free cloud hosted database here, or use the redis-stack Docker image (here) or use the Docker compose file at the root of this repository.
  • A fully set up and working instance of the receiver component (read about this here) which is also connected to the same Redis Stack instance you are using for this component.
  • An API key for the FlightAware Aero API. Note this this is a paid API - you do get some calls without charge but you will need to sign up and provide a payment method.

First, configure the environment by copying env.example to .env. Edit this file to contain the Redis connection URL for your Redis instance (Redis URL format). You'll also need to add your FlightAware API key to the FLIGHTAWARE_API_KEY field.

Finally, install the dependencies:

npm install

Running the Enricher

Start the enricher component like this:

npm start

TODO what happens...