GEAS_dashboard_ / README.md
AIsekai's picture
Upload README.md with huggingface_hub
3535dc0 verified
|
Raw
History Blame Contribute Delete
2.33 kB

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

# 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

cd dashboard
npm run dev

Production Mode

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:

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

πŸ“ 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