https://github.com/tsembp/sql-gym

https://github.com/tsembp/sql-gym

fastapi react sqlalchemy tailwindcss typescript

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tsembp/sql-gym
• Owner: tsembp
• License: mit
• Created: 2025-06-16T09:32:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-07-08T08:43:32.000Z (12 months ago)
• Last Synced: 2025-07-08T08:43:36.619Z (12 months ago)
• Topics: fastapi, react, sqlalchemy, tailwindcss, typescript
• Language: Python
• Homepage:
• Size: 103 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🏋️ SQLGym

**SQLGym** is an interactive SQL challenge platform designed to help users practice SQL using realistic, fintech-style datasets — all in a clean local-first setup.

Built with a Python + FastAPI backend and a React + Tailwind frontend, SQLGym evaluates SQL queries safely and gives instant feedback using mock financial data (users, transactions, refunds, subscriptions).

## ✨ Features

- 🧠 15 realistic SQL challenges (from `BASIC` to `HARD`)

- 🔐 Secure backend with safe SQL evaluation (no DDL/DML)

- 🧾 Realistic mock financial datasets generated with `Faker`

- 💡 Frontend with challenge prompts, schema previews, and Monaco-based SQL editor

- ✅ Query correctness feedback with result previews

- ⚡ Local SQLite support for rapid development

// ...existing code...

## 📸 Preview

| Home Page                                     | Filtered View                                  |

|-----------------------------------------------|------------------------------------------------|

| ![Home](./screenshots/home-page.png)          | ![Challenge](./screenshots/home-page-filtered.png) |

| Challenge Page                                | Correct Solution                               |

|-----------------------------------------------|------------------------------------------------|

| ![Correct](./screenshots/challenge-preview.png) | ![Incorrect](./screenshots/challenge-preview-correct.png) |

| Incorrect Solution                      | SQL Injection Protection                                 |

|-----------------------------------------------|------------------------------------------------|

| ![SQLi](./screenshots/challenge-preview-incorrect.png) | ![Filtered](./screenshots/challenge-preview-sqli.png) |

## 🚀 Getting Started

### 1. Clone and setup environment

```bash

git clone https://github.com/tsembp/SQL-Gym.git

cd SQL-Gym

python -m venv venv

source venv/bin/activate  # or venv\Scripts\activate on Windows

pip install -r requirements.txt

````

### 2. Generate mock DB

```bash

python backend/db/db_seeder.py

```

### 3. Start backend

```bash

cd backend

uvicorn main:app --reload

```

### 4. Setup frontend

```bash

cd frontend/tailwindcss4

npm install

npm run dev

```

## 🗂️ Project Structure

```

sqlgym/

├── backend/

│   ├── main.py                 # FastAPI app

│   ├── challenge_definitions   # Challenges JSON

│   ├── db/

│   │   ├── db_seeder.py        # SQLite + Faker mock data

│   │   ├── models.py           # SQLAlchemy models

|   |   └── sqlgym.db           # Generated DB (gitignored)

├── frontend/

│   └── src/

│       ├── pages/

│       ├── api/

|       ...

```

## 🛠️ Tech Stack

* **Backend**: Python, FastAPI, SQLAlchemy, SQLite

* **Frontend**: React, TypeScript, Tailwind CSS, Vite

* **Editor**: Monaco Editor

* **Data**: Faker, Pandas

## 📈 Future Ideas

* 🤖 GPT-powered SQL hints

* 💬 AI assistant for each challenge

* 📊 Leaderboard or progress tracking

## 📄 License

MIT License © 2025 \[Panagiotis Tsembekis]