Datafeed Cache

The Datafeed Cache project is a wrapper around VATSIM's Datafeed service which provides basic caching functionality as well as failure detection. Every response includes an extra flag failed which indicates whether the last update made by the server was successful, or whether the datafeed failed to update. If failed is true, then the previously cached datafeed is returned as the response in data.

The API Documentation can be found in the wiki.

Important

The wiki still contains the older typescript type syntax. Semantically, the result types are identical though. To view the concrete implementation of the types used, visit the datafeed type definitions.

If you wish to contribute and/or make changes, please check out our contribution guide here.

Contact

Name	Responsible for	Contact
Nikolas G. - 1373921	*	git[at]vatger.de

Prerequisites

• Rust (tested with version 1.85.1)
• Cargo
• OpenSSL (required by reqwest)

Running the Application

Firstly clone the repository by running:

$ git clone https://github.com/vatger/datafeed-cache.git  
$ cd datafeed-cache  

You can build the application using cargo build or run it directly using cargo run, which will include the compilation steps.

You can also specify the type of release you would like to build (e.g. release) by specifying cargo build --release.

Using Docker

If you prefer to use Docker for production / development, you can use the provided docker-compose.yml file, or create your own. This compose-file will build the image and deploy it locally exposing port 8007 on the host machine.

$ docker compose up

To stop the deployed stack, run

$ docker compose down