Skip to content

FILE_STRUCTURE.md

Latest commit

 

History

History
77 lines (68 loc) · 3.09 KB

FILE_STRUCTURE.md

File metadata and controls

77 lines (68 loc) · 3.09 KB

Project File Structure

📁 Clean, Production-Ready Structure

chat-research-interface/
├── 📚 DOCUMENTATION
│   ├── README.md                     # Main project overview
│   ├── DEPLOYMENT.md                 # Vercel deployment guide
│   ├── QUALTRICS_INTEGRATION.md      # Survey embedding instructions
│   ├── SUPABASE_SETUP.md            # Database configuration
│   ├── IMPLEMENTATION_SUMMARY.md     # Feature overview & status
│   └── .env.example                  # Environment variables template
│
├── ⚙️ CONFIGURATION
│   ├── package.json                  # Dependencies & scripts
│   ├── tsconfig.json                 # TypeScript configuration
│   ├── vercel.json                   # Deployment configuration
│   └── supabase-setup.sql           # Database schema
│
├── 🌐 PUBLIC ASSETS
│   └── public/
│       └── index.html               # Main HTML template
│
└── 💻 SOURCE CODE
    └── src/
        ├── App.tsx                  # Main application component
        ├── App.css                  # Global styles
        ├── index.tsx               # Application entry point
        │
        ├── 🧩 COMPONENTS/
        │   ├── ChatInterface.tsx    # Main chat interface
        │   ├── Home.tsx            # Scenario selection page
        │   ├── ProlificIdEntry.tsx  # ID collection component
        │   └── ScenarioRouter.tsx   # Route validation
        │
        ├── 📊 DATA/
        │   └── scenarios.ts         # All 8 research scenarios
        │
        ├── 🔧 SERVICES/
        │   ├── conversationService.ts  # Database operations
        │   ├── openaiService.ts       # AI chat integration
        │   └── supabaseClient.ts      # Database client
        │
        ├── 🎨 STYLES/
        │   ├── ChatInterface.css    # Chat interface styles
        │   ├── Home.css            # Home page styles
        │   └── ProlificIdEntry.css  # ID entry styles
        │
        └── 📝 TYPES/
            └── index.ts             # TypeScript type definitions

🗑️ Removed Unnecessary Files

  • ❌ PROJECT_README.md (duplicate documentation)
  • ❌ TESTING_RESULTS.md (development-only file)
  • ❌ public/scenario-pages/ (unused directory)
  • ❌ build/ (auto-generated, will be created on deployment)

✅ Essential Files Only

The project now contains only the essential files needed for:

  • Development - Complete source code and configuration
  • Deployment - Production build and deployment configs
  • Documentation - Comprehensive setup and usage guides
  • Research - All scenarios and data collection capabilities

🚀 Ready for Version Control

This clean structure is optimized for:

  • Git repository management
  • Vercel deployment
  • Team collaboration
  • Long-term maintenance

All unnecessary files have been removed while preserving complete functionality and comprehensive documentation.