Skip to content

README.md

Latest commit

 

History

History
32 lines (22 loc) · 1.18 KB

README.md

File metadata and controls

32 lines (22 loc) · 1.18 KB

AskSQL AI

Convert natural language questions into PostgreSQL queries with a heavy-duty, premium AI-powered interface.

🚀 Features

  • Intuitive NL to SQL: Powered by Gemini 2.5 Flash for high accuracy.
  • Midnight Sapphire UI: Ultra-premium dark theme with advanced glassmorphism.
  • Live Database Connection: Automatically reflects your current schema.
  • Dynamic Schema Creator: Create tables with support for TEXT, INTEGER, FLOAT, TIMESTAMP, and DATE.
  • Execution Safety: Strict read-only validation blocks destructive commands.

🛠️ Tech Stack

  • Frontend: React 18, Vite, TypeScript, Custom CSS (Midnight theme).
  • Backend: FastAPI, PostgreSQL, Google GenAI SDK.
  • Orchestration: Docker & Docker Compose.

📦 Quick Start

  1. API Key: Get a Gemini API key from Google AI Studio.
  2. Environment: Add your keys and DB config to backend/.env.
  3. Run: 
    docker-compose up --build

Access the app at: http://localhost:3000

🔒 Security

All generated SQL queries are parsed for restricted keywords (DROP, DELETE, etc.) before execution to ensure a read-only experience for the AI.