Flights Dashboard

A dashboard service for displaying flights, airports and aircompanies data. This project is based on the data available on Kaggle through the following link: 2015 Flight Delays and Cancellations.

Features

• API on the backend to fetch and save data to our database.
• Frontend interactive dashboard.
• Add frontend responsiveness.

Tech Stack

• Backend: FastAPI.
• Frontend: React, html, css and JavaScript.

Installation

1. Clone the repository:

git clone "https://github.com/brenoingwersen/flight-dash.git"

2. Navigate to the project directory:

cd flight-dash

Backend (In progress)

Backend docs: api/README.md

Run using Docker compose

First create a .env file for the newuser:

POSTGRES_DB=flight-delays
POSTGRES_USER=newuser # User created for the PostgreSQL image
POSTGRES_PASSWORD=user
POSTGRES_HOST=database
POSTGRES_PORT=5432

The newuser is created when the database container is firstly initialized with the files from /.docker/new_user.sql. This is just to simulate a real-life scenario in which you have a user with access to your database and this user is accessed only by your backend API. And the user wouldn't be PostgreSQL superuser.

This command runs the container using docker on detached mode - i.e. the server is running on the background of the terminal.

docker compose up -d --build

The server should be up now and the API docs should be available on http://localhost:8000/docs.

To stop the container and clear the volumes run the command:

docker compose down -v

Frontend (To be Developed)

The frontend of the application will provide an interactive dashboard for visualizing the flight data. It will be developed using React to ensure a modern and responsive user interface. Stay tuned for updates on the frontend development progress.

Useful Resources

A list of useful resources that helped me throughout the project.

• Conventional commits - The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history.
• The Blue Book - A Digital Garden created by Lyz with contributions. There's a section on FastAPI. But checkout the other sections for a really nice content.