Skip to content

START_HERE.md

Latest commit

 

History

History
120 lines (84 loc) · 3.37 KB

START_HERE.md

File metadata and controls

120 lines (84 loc) · 3.37 KB

🎉 You're All Set! Start Here

✅ Setup Complete!

Your ActualCode environment is ready to use!

🚀 Quick Start (30 seconds)

Option 1: Using the Run Script (Easiest)

cd /Users/muratcankoylan/ActualCode/hackathon_code

# Set your GitHub token first
export GITHUB_TOKEN=your_github_token_here

# Run the automated script
./run.sh

Option 2: Manual Steps

cd /Users/muratcankoylan/ActualCode/hackathon_code

# 1. Set environment variables
export GITHUB_TOKEN=your_github_token_here
export GOOGLE_CLOUD_PROJECT=true-ability-473715-b4
export GOOGLE_APPLICATION_CREDENTIALS=/Users/muratcankoylan/ActualCode/true-ability-473715-b4-22e5d8ca9981.json
export GOOGLE_CLOUD_REGION=us-central1

# 2. Activate virtual environment
source venv/bin/activate

# 3. Run the CLI
python cli_runner.py

📝 What to Expect

When you run the CLI, you'll see:

  1. Interactive prompts for:

    • GitHub repository URL (e.g., facebook/react or expressjs/express)
    • Difficulty level (easy/medium/hard/expert)
    • Problem type (feature/bug-fix/refactor/optimization)
    • Time limit (60/120/180/240 minutes)

  2. Real-time progress showing:

    • Repository data fetching from GitHub
    • 7 AI agents analyzing the codebase
    • Problem generation and QA validation
    • Final assessment creation

  3. Output file: assessment_YYYYMMDD_HHMMSS.json

🎯 Try These Repositories

Small & Fast (good for testing):

  • sindresorhus/is (TypeScript)
  • minimaxir/big-list-of-naughty-strings (Testing data)

Medium Size:

  • expressjs/express (Node.js web framework)
  • pallets/flask (Python web framework)

Large (takes longer):

  • facebook/react (JavaScript UI library)
  • vercel/next.js (React framework)

⚡ Example Session

$ export GITHUB_TOKEN=your_github_token_here
$ cd /Users/muratcankoylan/ActualCode/hackathon_code
$ ./run.sh

🚀 Starting ActualCode CLI...
✅ Loaded Google Cloud credentials from .env
✅ GitHub token configured
✅ Virtual environment activated

════════════════════════════════════════════════════════════════
                  Ready to Generate Assessment                  
════════════════════════════════════════════════════════════════

[Beautiful banner appears]

GitHub Repository URL: expressjs/express
Select Difficulty: [2] medium
Select Problem Type: [1] feature
Time Limit: [3] 180 minutes
Proceed? y

[2-3 minutes of AI magic...]

🎉 Assessment Generated Successfully!
Problem Title: Implement Advanced Middleware System
✅ Saved to: assessment_20250930_160000.json

🔐 Security Note

⚠️ IMPORTANT: Your GitHub token has been removed from SETUP_GITHUB.md for security.

Never commit tokens to files! Always use:

  • Environment variables: export GITHUB_TOKEN='...'
  • Shell config files (.bashrc, .zshrc) for permanent setup
  • Secret managers for production

📚 Documentation

  • This file: Quick start guide
  • CLI_GUIDE.md: Full CLI documentation
  • PRODUCTION_READY.md: Architecture and features
  • SETUP_GITHUB.md: GitHub token setup guide

🎊 You're Ready!

Run ./run.sh and start generating awesome coding assessments! 🚀