iamseki / api-binary-compressed-example

Instructions

This repository is an example of how to send and retrieving binary data through an express API.

• The frontend client read the csv file as binary, compressing using GZIP algorithm and sending it to the backend server through a HTTP POST at /upload/compress endpoint.

• The backend receives the binary compressed data from request body and writes into backend/tmp/gzip file.

Runnning backend 📜

The backend nodejs server is listening by default at port 9000, we can run with:

• make run-backend

Running frontend 📜

There is a python client that sends the airtravel.csv in root folder when we run:

• make run-frontend

Tips 🔖

You may need to install dependencies, there's a Make command for both:

• make install-backend-deps
• make install-frontend-deps

You might need to visualize the received binary data as well, to do so:

• cd backend/tmp/gzip
• gzip -d PUT_FILENAME_HERE