• 📚 Documentation Index - environment-setup-v1 Branch
  • Branch Information
  • 📋 Available Documentation
    • 🎯 Core Setup Guides
    • 🚀 Management Scripts
    • ⚙️ Configuration Files
  • 🔧 Quick Access Commands
    • Documentation Access
    • System Status
    • Development Stack
  • 📊 Current Working Status
    • ✅ Confirmed Working
    • 🔄 Ready for Setup
  • 🎯 Branch-Specific Features
  • 🔀 Branch Context
    • Why This Branch Exists
    • How to Use This Branch

Auto-imported from: D:/repos/aiegoo/uconGPT/eng2Fix/kor2fix/DOCS-INDEX.md
Original filename: DOCS-INDEX.md
Import date: Wed, Oct 08, 25

📚 Documentation Index - environment-setup-v1 Branch

Branch Information

• Branch: environment-setup-v1
• Status: ✅ Active with working backend (port 8201)
• Focus: Dedicated port allocation + Python 3.13 compatibility
• Date: August 7, 2025

📋 Available Documentation

🎯 Core Setup Guides

| File | Purpose | Status | |——|———|———| | README-environment-setup-v1.md | Branch overview & quick start | ✅ Available | | docs/DOCKER-SETUP.md | Docker Desktop installation | ✅ Available | | docs/PORT-ALLOCATION.md | Complete port reference (8200-8299) | ✅ Available |

🚀 Management Scripts

| Script | Purpose | Status | |——–|———|———| | scripts/start-dev-stack.sh | Development stack management | ✅ Executable | | test_setup.py | Python 3.13 compatibility validation | ✅ Available |

⚙️ Configuration Files

| File | Purpose | Status | |——|———|———| | .env.example | Environment variables (8200-8299 ports) | ✅ Available | | docker-compose.yml | Multi-service orchestration | ✅ Available | | requirements.txt | Python 3.13 compatible dependencies | ✅ Available |

🔧 Quick Access Commands

Documentation Access

# Verify you're on the right branch
git branch --show-current  # Should show: environment-setup-v1

# View branch-specific documentation
cat README-environment-setup-v1.md
cat docs/DOCKER-SETUP.md  
cat docs/PORT-ALLOCATION.md

System Status

# Check current service status
./scripts/start-dev-stack.sh status

# Test backend API
curl http://localhost:8201/health
curl http://localhost:8201/api/config

Development Stack

# Start services
./scripts/start-dev-stack.sh start

# View logs
./scripts/start-dev-stack.sh logs

# Stop services
./scripts/start-dev-stack.sh stop

📊 Current Working Status

✅ Confirmed Working

• FastAPI Backend: Running on port 8201
• Health Monitoring: Complete system status API
• Port Configuration: Full service mapping API
• Python 3.13: Compatible dependency set
• Development Scripts: Service management automation

🔄 Ready for Setup

• Docker Services: Use docs/DOCKER-SETUP.md guide
• Ollama LLM: Port 8203 allocated and ready
• MongoDB: Port 8202 configured
• Frontend: Port 8206 reserved

🎯 Branch-Specific Features

This environment-setup-v1 branch provides:

1. Conflict-Free Ports: 8200-8299 dedicated range
2. Python 3.13 Support: Compatible minimal dependencies
3. Docker Ready: Complete containerization setup
4. Korean Language Focus: Specialized API endpoints
5. Health Monitoring: Comprehensive system status
6. Development Automation: One-command stack management

🔀 Branch Context

Why This Branch Exists

• Port Conflicts: Avoids typical development ports (3000, 8000, 5000)
• Python 3.13: Early adoption with compatibility focus
• Clean Architecture: Dedicated service isolation
• Production Ready: Docker + health monitoring

How to Use This Branch

# Switch to this branch
git checkout environment-setup-v1

# Follow the documentation
cat README-environment-setup-v1.md

# Start development
./scripts/start-dev-stack.sh start