~/wiki

Workshop Environment Setup

Confiance : high
workshop-setupdeveloper-environmentdockernodejscli-toolsapi-securityenvironment-automationtechnical-educationproduction-readinessdependency-management

Systematic approach to preparing development environments for technical workshops and hackathons. Emphasizes parallel installation processes, security best practices, and comprehensive testing procedures to ensure smooth hands-on learning experiences.

Core Components

Technical Stack Requirements

Runtime Environments:

  • Node.js (v22+) with npm package management
  • Python (3.14+) with virtual environment capabilities
  • Docker daemon with image building support

CLI Tools:

  • ant CLI for agent management and API authentication
  • Version control (git) for repository management
  • Package managers (homebrew on macOS, apt on Linux)

Specialized Dependencies:

  • LibreOffice integration for document processing workshops
  • Streamlit for rapid web interface development
  • Docker image builds for isolated evaluation environments

Security Configuration

API Key Management:

  • Proper .env file structure (excluded from version control)
  • Distinction between .env.example (committed templates) and .env (actual credentials)
  • Authentication verification procedures
  • Credit claiming and organization ID submission workflows

Common Security Issues:

  • Real API keys committed in example files
  • Missing gitignore entries for credential files
  • Shared credentials across multiple workshop environments
  • Lack of authentication testing before events

Environment Validation

Smoke Testing Procedures:

# Authentication verification
ant beta:agents list

# Docker functionality
docker run --rm image-name command

# Python environment activation
source .venv/bin/activate
streamlit run app.py

# Node.js dependency verification  
npm run test

Pre-Event Checklist:

  • All dependencies installed and versioned
  • API authentication working
  • Docker images built and tested
  • Python virtual environments activated
  • Repository cloned with correct permissions
  • Security credentials properly isolated

Parallel Setup Strategy

Efficient Installation Patterns:

  1. Start long-running processes first (Docker image builds)
  2. Install lightweight dependencies in parallel
  3. Verify authentication while other processes complete
  4. Perform final integration testing

Time Management:

  • Docker builds: 5-10 minutes (LibreOffice images)
  • Python environment setup: 2-3 minutes
  • CLI tool installation: 1-2 minutes
  • Authentication and testing: 2-3 minutes
  • Total setup time: 10-15 minutes with parallel execution

Workshop-Specific Configurations

Managed Agent Development:

  • Python virtual environments with anthropic, streamlit, plotly, dotenv
  • API key configuration for agent deployment
  • Local development server setup (localhost:8501)

Evaluation Frameworks:

  • Docker images with LibreOffice and font dependencies
  • npm dependencies for evaluation tooling
  • Environment variable configuration for evaluation runs

Memory Systems:

  • Dreaming service preview enrollment
  • Organization UUID configuration
  • Memory store integration testing

Production Readiness Patterns

Error Handling

Common Installation Failures:

  • Docker daemon not running
  • Node.js version incompatibility
  • Python virtual environment conflicts
  • API authentication failures
  • Missing system dependencies

Recovery Procedures:

  • Incremental verification at each step
  • Clear error messages and troubleshooting steps
  • Fallback installation methods
  • Manual verification commands

Documentation Standards

Setup Instructions Format:

  • Prerequisites clearly stated
  • Step-by-step installation procedures
  • Verification commands for each step
  • Troubleshooting common issues
  • Time estimates for each phase

Environment Documentation:

  • Dependency versions and compatibility matrices
  • Security configuration requirements
  • Workshop-specific customizations
  • Post-setup validation procedures

See also