Here is a styled, polished, drop-in README.md designed to look great directly inside VS Code or GitHub. It includes emojis, headings, badges, code blocks, and section dividers.

You can paste this exactly as-is into README.md.

# 🚕 NYC Taxi Analytics Platform  
### **End-to-End Data Engineering + API + Frontend Dashboard**  
*(Airflow • Postgres • FastAPI • Docker • React)*

---

<div align="center">

📊 **Modern Data Stack Project** • 🛠 **Production-grade Architecture** • 🌐 **Full-Stack Analytics**

</div>

---

## 🌟 Overview

This project is a **complete analytics platform** that ingests NYC TLC taxi trip data, pipelines it through Airflow, stores it in a Postgres warehouse, exposes analytical endpoints through FastAPI, and visualizes insights via a React dashboard.

It combines **data engineering**, **backend API development**, and **frontend data visualization** into one cohesive, containerized system.

---

## 🧱 Architecture

            ┌─────────────────────┐
            │  NYC Taxi Parquet    │
            └─────────┬────────────┘
                      │
                      ▼
            ┌─────────────────────┐
            │       Airflow       │
            │ Extract → Load →    │
            │ Raw Postgres Table  │
            └─────────┬───────────┘
                      │
                      ▼
        ┌────────────────────────────┐
        │  Postgres Warehouse        │
        │ Table: raw_nyc_taxi_trips  │
        └─────────┬──────────────────┘
                  │
                  ▼
    ┌─────────────────────────┐
    │      FastAPI Service    │
    │  /api/metrics/*         │
    └──────────┬──────────────┘
               │
               ▼
  ┌────────────────────────────┐
  │      React Dashboard       │
  │ Charts • KPIs • Insights   │
  └────────────────────────────┘

---

## 📁 Project Structure

nyc-taxi/ │ ├── docker-compose.yml │ ├── airflow/ │ ├── dags/ │ ├── logs/ │ ├── scripts/ │ └── plugins/ │ ├── api/ │ ├── main.py │ ├── requirements.txt │ └── Dockerfile │ └── frontend/ ├── src/ └── vite.config.js

---

# 🚀 Getting Started

## 1️⃣ Clone the Repo

```bash
git clone https://github.com/cjtakhar/nyc-taxi-dash
cd nyc-taxi

docker compose up -d --build

This will start:

• Airflow scheduler
• Airflow webserver
• Airflow metadata DB
• Postgres warehouse (NYC taxi data)
• FastAPI backend

cd frontend
npm install
npm run dev

Dashboard will be available at:

👉 http://localhost:3000

Airflow login:

admin / admin

The Airflow DAG:

• Loads NYC Yellow Taxi Parquet files
• Cleans & normalizes columns
• Bulk loads the data using COPY into Postgres

Raw table produced:

raw_nyc_taxi_trips

This table drives all analytics.

FastAPI exposes analytical endpoints that query the warehouse.

Returns total trips, revenue, avg fare, and avg tip %.

Returns daily revenue + trip counts.

Trips per hour of day + avg distance.

Tip % broken down by payment method.

Example request:

curl "http://localhost:8000/api/metrics/summary?start=2023-01-01&end=2023-01-31"

The frontend visualizes all metrics using:

• KPI cards
• Time-series charts
• Revenue analytics
• Hourly breakdown
• Payment-type tip analysis

It calls the FastAPI backend using fetch/axios.

Visit:

👉 http://localhost:8000/docs

or use curl:

curl "http://localhost:8000/api/metrics/daily_revenue?start=2023-01-01&end=2023-01-31"

This project is fully containerized and can be deployed to:

• AWS ECS / Fargate
• Azure Container Apps
• Google Cloud Run
• DigitalOcean
• Kubernetes

MIT License.

Built by CJ Takhar