README.md

# EV Grid Advisory Dashboard

Interactive visualization for electric vehicle integration into distribution grids.

## 📍 Bundle Placement

When cloning from GitHub, the complete project structure is preserved:

```
grid-ev-advisory/
├── dashboard/           ← You are here
├── offline/
├── notebooks/
├── data/
└── README.md
```

## 🎯 Getting Started

### From Full Project Clone

```bash
# 1. Clone the main project
git clone https://github.com/Youssef-Azzam/Grid-EV-advisory
cd grid-ev-advisory

# 2. Go to dashboard directory
cd dashboard

# 3. Install Node dependencies
npm install

# 4. Choose your setup:

# Option A: Development (hot reload)
npm run dev
# Visit http://localhost:5173/

# Option B: Production build
npm run build
# Files saved to: dashboard/dist/
# Then serve with: http-server dist/
# Visit http://127.0.0.1:8080
```

## 🚀 Serving the Dashboard

### Development Mode
```bash
cd dashboard
npm run dev
```

### Production Mode
```bash
cd dashboard
npm run build
http-server dist/
# Visit http://127.0.0.1:8080 or other URLs shown
```

## ⚠️ Important: Directory Structure

**When using `http-server`, ALWAYS be in the `dashboard/` directory:**

```bash
cd dashboard
http-server dist/        ✅ Correct
http-server public/      ✅ Correct

# From project root - these will fail (404):
http-server dashboard/dist/    ❌ Wrong - looks for dashboard/dashboard/dist/
```

## 📦 Build Output

After `npm run build`, the bundle is created at:
```
dashboard/dist/
├── index.html
├── assets/
└── [other files]
```

Deploy this `dist/` folder to:
- GitHub Pages
- Netlify, Vercel
- Any static hosting service
- Docker container
- Self-hosted server

## 📊 Features

- Interactive scenario browser (1,008 scenarios)
- Grid stress visualization with Leaflet maps
- Time navigation (96 timesteps per scenario)
- Bus-level detail view
- Filter by EV count and severity

## 🔗 Links

- **Main Project:** https://github.com/Youssef-Azzam/Grid-EV-advisory
- **Live Dashboard:** https://Youssef-Azzam.github.io/Grid-EV-advisory/

## 📝 Available Scripts

- `npm run dev` – Start dev server (port 5173)
- `npm run build` – Create production bundle in `dist/`
- `npm run preview` – Preview production build
- `npm run lint` – Check code quality