Skip to content

FILE_TREE.md

Latest commit

 

History

History
290 lines (235 loc) · 8.64 KB

FILE_TREE.md

File metadata and controls

290 lines (235 loc) · 8.64 KB

📁 Complete File Tree

Project Structure with MIT PDDL Integration

PDDL/
│
├── 📚 Documentation (11 files)
│   ├── FINAL_SUMMARY.md                    ⭐ START HERE
│   ├── START_LOCAL.md                      🚀 Quick start (5 min)
│   ├── DEPLOYMENT_GUIDE.md                 ☁️  Deploy to production
│   ├── README_RLHF.md                      📖 Main documentation
│   ├── MIT_PDDL_INTEGRATION.md             🎓 MIT BlocksWorld standards (NEW)
│   ├── MIT_PDDL_ARCHITECTURE.md            🏗️  Architecture diagrams (NEW)
│   ├── CHANGELOG_MIT_PDDL.md               📝 Integration changes (NEW)
│   ├── FUNCTIONAL_REQUIREMENTS.md          📋 Complete specification
│   ├── PROJECT_SUMMARY.md                  📊 Project overview
│   ├── QUICK_REFERENCE.md                  ⚡ Cheat sheet
│   └── README.md                            📄 Original README
│
├── 🔧 Backend (FastAPI) → Railway
│   ├── main.py                              ⭐ Enhanced with MIT PDDL
│   ├── requirements.txt                     📦 Python dependencies
│   ├── railway.json                         🚂 Railway deployment config
│   ├── training_data/                       💾 Generated RLHF datasets
│   │   └── rlhf_session_*.json             (created when feedback submitted)
│   └── README.md                            📖 Backend documentation
│
├── 🎨 Frontend (React + Vite) → Vercel
│   ├── src/
│   │   ├── api/
│   │   │   └── pddl.js                     🔌 API service layer
│   │   ├── components/
│   │   │   ├── StepFeedback.jsx            👍 Step rating component
│   │   │   ├── StepFeedback.css            💅 Step styles
│   │   │   ├── DatasetDisplay.jsx          📊 Dataset viewer
│   │   │   └── DatasetDisplay.css          💅 Dataset styles
│   │   ├── App.jsx                         🎯 Main application
│   │   ├── App.css                         💅 Global styles
│   │   ├── main.jsx                        🚪 Entry point
│   │   └── index.css                       💅 Base styles
│   ├── public/
│   │   └── vite.svg                        🖼️  Vite logo
│   ├── index.html                          📄 HTML template
│   ├── package.json                        📦 npm dependencies
│   ├── package-lock.json                   🔒 Dependency lock
│   ├── vite.config.js                      ⚙️  Vite configuration
│   ├── vercel.json                         ▲ Vercel deployment config
│   ├── eslint.config.js                    🔍 ESLint config
│   └── README.md                           📖 Frontend documentation
│
├── 🛠️  Original CLI Tool
│   ├── pddl_planner.py                     💻 Original command-line tool
│   ├── requirements.txt                     📦 CLI dependencies
│   └── oxy_warrant_analysis_result.txt     📄 Example output
│
└── 📊 Project Metadata
    ├── DIRECTORY_STRUCTURE.txt              📁 File listing
    └── FILE_TREE.md                         📁 This file

📊 File Statistics

Code Files

Category Files Lines (approx)
Backend 1 Python file ~500 lines
Frontend 4 JSX + 4 CSS ~800 lines
Original CLI 1 Python file ~200 lines
Total Code 10 files ~1,500 lines

Documentation Files

Document Lines Status
FINAL_SUMMARY.md 400 ⭐ NEW
MIT_PDDL_INTEGRATION.md 450 ⭐ NEW
MIT_PDDL_ARCHITECTURE.md 350 ⭐ NEW
CHANGELOG_MIT_PDDL.md 300 ⭐ NEW
DEPLOYMENT_GUIDE.md 400 ✅ Complete
START_LOCAL.md 250 ✅ Complete
FUNCTIONAL_REQUIREMENTS.md 420 ✅ Complete
README_RLHF.md 320 ✅ Updated
PROJECT_SUMMARY.md 350 ✅ Complete
QUICK_REFERENCE.md 200 ✅ Updated
backend/README.md 110 ✅ Complete
frontend/README.md 150 ✅ Complete
Total Documentation 3,700+ lines

Configuration Files

File Purpose
backend/railway.json Railway deployment
backend/requirements.txt Python dependencies
frontend/vercel.json Vercel deployment
frontend/package.json npm dependencies
frontend/vite.config.js Vite build config
frontend/eslint.config.js Code linting

🎯 Key Files to Know

For Getting Started

  1. FINAL_SUMMARY.md - Complete overview of everything
  2. START_LOCAL.md - Run locally in 5 minutes
  3. QUICK_REFERENCE.md - Quick command reference

For MIT PDDL Integration

  1. MIT_PDDL_INTEGRATION.md - Complete MIT standards guide
  2. MIT_PDDL_ARCHITECTURE.md - Architecture diagrams
  3. CHANGELOG_MIT_PDDL.md - What changed

For Deployment

  1. DEPLOYMENT_GUIDE.md - Deploy to Vercel + Railway
  2. backend/railway.json - Railway configuration
  3. frontend/vercel.json - Vercel configuration

For Development

  1. backend/main.py - Backend API (enhanced with MIT PDDL)
  2. frontend/src/App.jsx - Main React application
  3. frontend/src/api/pddl.js - API service layer

📦 Dependencies

Backend (backend/requirements.txt)

fastapi==0.109.0
uvicorn==0.27.0
pydantic==2.5.3
requests==2.31.0
python-dotenv==1.0.0

Frontend (frontend/package.json)

{
  "dependencies": {
    "axios": "^1.12.2",
    "react": "^19.1.1",
    "react-dom": "^19.1.1"
  },
  "devDependencies": {
    "@vitejs/plugin-react": "^5.0.4",
    "vite": "^7.1.7",
    "eslint": "^9.36.0"
  }
}

🆕 New Files (MIT Integration)

Documentation

  • ✅ MIT_PDDL_INTEGRATION.md (450 lines)
  • ✅ MIT_PDDL_ARCHITECTURE.md (350 lines)
  • ✅ CHANGELOG_MIT_PDDL.md (300 lines)
  • ✅ FINAL_SUMMARY.md (400 lines)
  • ✅ FILE_TREE.md (this file)

Code

  • ✅ Enhanced backend/main.py (+200 lines)
    • extract_pddl_components() function
    • validate_pddl_syntax() function
    • Enhanced generate_rlhf_dataset() function

Updated

  • ✅ README_RLHF.md (dataset format updated)
  • ✅ QUICK_REFERENCE.md (added MIT docs link)

🗂️ Directory Sizes (Approximate)

backend/          ~50 KB (code + configs)
frontend/         ~2 MB (with node_modules: ~200 MB)
Documentation/    ~400 KB (all .md files)
training_data/    varies (datasets saved here)

🔍 File Categories

📚 Read First

  • FINAL_SUMMARY.md
  • START_LOCAL.md
  • QUICK_REFERENCE.md

🎓 MIT Integration

  • MIT_PDDL_INTEGRATION.md
  • MIT_PDDL_ARCHITECTURE.md
  • CHANGELOG_MIT_PDDL.md

🚀 Deployment

  • DEPLOYMENT_GUIDE.md
  • backend/railway.json
  • frontend/vercel.json

💻 Development

  • backend/main.py
  • frontend/src/App.jsx
  • frontend/src/components/*.jsx

📖 Reference

  • FUNCTIONAL_REQUIREMENTS.md
  • PROJECT_SUMMARY.md
  • backend/README.md
  • frontend/README.md

🎯 Quick Navigation

Want to...

  • 🚀 Start using it? → Read START_LOCAL.md
  • ☁️ Deploy it? → Read DEPLOYMENT_GUIDE.md
  • 🎓 Understand MIT integration? → Read MIT_PDDL_INTEGRATION.md
  • 📊 See architecture? → Read MIT_PDDL_ARCHITECTURE.md
  • 📝 See what changed? → Read CHANGELOG_MIT_PDDL.md
  • ⚡ Quick commands? → Read QUICK_REFERENCE.md
  • 🔍 Complete overview? → Read FINAL_SUMMARY.md

✅ Completeness Check

Backend ✅

  • API server (main.py)
  • MIT PDDL extraction
  • PDDL validation
  • Dataset generation
  • Requirements file
  • Railway config
  • Documentation

Frontend ✅

  • Main app (App.jsx)
  • API service (pddl.js)
  • Step feedback component
  • Dataset display component
  • All styling (CSS)
  • Package.json
  • Vercel config
  • Documentation

Documentation ✅

  • Main documentation (8 files)
  • MIT integration docs (3 files)
  • Backend docs
  • Frontend docs
  • Deployment guides
  • Quick references

Configuration ✅

  • Backend deployment (Railway)
  • Frontend deployment (Vercel)
  • Python dependencies
  • npm dependencies
  • Build configurations

🎉 Total Project

  • Total Files: ~30 core files
  • Total Lines of Code: ~1,500 lines
  • Total Documentation: ~3,700 lines
  • Total Size: ~2.5 MB (without node_modules)

Project Status: ✅ COMPLETE

All files created, documented, and ready for use!

Last Updated: October 5, 2025