Skip to content

QUICKSTART.md

Latest commit

 

History

History
91 lines (63 loc) · 1.98 KB

QUICKSTART.md

File metadata and controls

91 lines (63 loc) · 1.98 KB
Raw

🚀 Quick Start Guide

Get the Educational Visualizer running in 5 minutes!

Step 1: Clone or Download

Download the project files to your computer.

Step 2: Backend Setup (2 minutes)

# Navigate to backend directory
cd backend

# Create virtual environment
python -m venv venv

# Activate virtual environment
# On Mac/Linux:
source venv/bin/activate
# On Windows:
venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Set up API key
cp .env.example .env
# Edit .env and add your ANTHROPIC_API_KEY
# Get your key from: https://console.anthropic.com/

# Run backend
python main.py

Backend will run at: http://localhost:8000

Step 3: Frontend Setup (2 minutes)

Open a NEW terminal window:

# Navigate to frontend directory
cd frontend

# Install dependencies (this might take a minute)
npm install

# Start development server
npm start

Frontend will open automatically at: http://localhost:3000

Step 4: Try It Out! (1 minute)

  1. Click on any example question, or
  2. Type your own question like:
    • "Explain the Pythagorean theorem"
    • "Graph a sine wave"
    • "Show projectile motion"

Troubleshooting

Backend Error: "ANTHROPIC_API_KEY not found"

  • Make sure you created .env file in backend/ directory
  • Add your API key: ANTHROPIC_API_KEY=sk-ant-...

Frontend Error: "Cannot connect to backend"

  • Verify backend is running on port 8000
  • Check terminal for backend errors

Visualization Not Rendering

  • Check browser console (F12) for errors
  • Try a different example question
  • Make sure backend is responding (check Network tab)

Need Help?

Next Steps

  • Try different types of questions
  • View the generated code with "View Code" button
  • Modify the system prompt in backend/main.py to customize behavior
  • Add more example questions in the examples endpoint

Happy Learning! 🎓