Skip to content

Getting Started

Jump to bottom
UnDaoDu edited this page Jul 3, 2025 · 1 revision

🚀 Getting Started with FoundUps Development

Welcome to the FoundUps ecosystem! This guide will help you understand how to contribute to the planetary-scale solution to systemic inequality and extractive capitalism.

🎯 Quick Orientation

What You're Building

  • Not just software - Infrastructure for post-capitalist innovation
  • Not just modules - Autonomous agents that build and evolve other modules
  • Not just code - Economic and social transformation tools

What Makes This Different

  • WSP Protocol Compliance - Every change is atomic, testable, and reversible
  • WRE Orchestration - Modular components that collaborate autonomously
  • Bitcoin Integration - Decentralized value flows without gatekeepers
  • Regenerative Focus - Solutions that heal rather than extract

🛠️ Development Environment Setup

Prerequisites

# Required
- Python 3.12+
- Git
- GitHub account

# Recommended  
- VS Code or Cursor IDE
- Bitcoin wallet (for future economic integration)
- Understanding of modular architecture principles

Repository Setup

# Clone the repository
git clone https://github.com/Foundup/Foundups-Agent.git
cd Foundups-Agent

# Set up Python environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install pytest pytest-cov pytest-asyncio

# Verify setup
python -m pytest modules/ -v

WRE Core Verification

# Test the core orchestration engine
cd modules/wre_core
python -m pytest tests/ -v

# Run the POC interface (optional)
python src/wre_core_poc.py

📋 WSP Compliance Workflow

Every contribution must follow the Windsurf Protocol (WSP) standards:

1. Pre-Development (WSP 2) 

# Create clean state snapshot
python -c "
from modules.wre_core.src.components.clean_state_manager import WSP2CleanStateManager
from pathlib import Path
csm = WSP2CleanStateManager(Path('.'))
result = csm.create_clean_state_snapshot('Pre-development checkpoint')
print(f'Clean state: {result[\"tag_name\"]}')
"

2. Module Creation (WSP 33) 

# Use the autonomous module creation workflow
cd modules/wre_core
python src/wre_core_poc.py
# Select option 2: "New Module Build"
# Follow the WSP 33 guided workflow

3. Development Standards (WSP 1-5)

  • WSP 1: Follow the 6 core principles (modularity, protocols, recursion, etc.)
  • WSP 3: Place modules in correct enterprise domains
  • WSP 4: Run FMAS audit: python tools/modular_audit/modular_audit.py modules/
  • WSP 5: Maintain ≥90% test coverage
  • WSP 6: Ensure all tests pass: pytest modules/ -v

4. Documentation (WSP 7-10)

  • Update README.md with implementation details
  • Create INTERFACE.md for module APIs
  • Update ModLog.md with changes
  • Commit with WSP-compliant messages

🏗️ Module Architecture Guide

Enterprise Domain Structure

modules/
├── ai_intelligence/       # AI and ML capabilities
├── communication/         # Messaging and chat systems  
├── platform_integration/  # External platform connectors
├── infrastructure/        # Core system services
├── gamification/         # Engagement and rewards
├── blockchain/           # Crypto and decentralized systems
├── foundups/             # FoundUps-specific logic
└── wre_core/             # Orchestration engine

Module Template

# modules/domain/your_module/src/your_module.py
"""
Your Module - Brief description

WSP Compliance:
- WSP 1: Modular design with clear interfaces
- WSP 3: Correctly placed in enterprise domain
- WSP 5: ≥90% test coverage maintained
"""

class YourModule:
    """
    Main module class following WSP patterns.
    
    Provides:
    - Clear interface definition
    - Atomic operations
    - Error handling with logging
    - Integration with WRE orchestration
    """
    
    def __init__(self):
        self.initialized = True
    
    def process(self, input_data):
        """
        Primary processing function.
        
        Args:
            input_data: Input following defined interface
            
        Returns:
            Dict with standardized response format
        """
        try:
            # Your implementation
            result = {"status": "success", "data": processed_data}
            return result
        except Exception as e:
            return {"status": "error", "error": str(e)}

🧪 Testing Requirements

Test Structure

# modules/domain/your_module/tests/test_your_module.py
import pytest
from modules.domain.your_module.src.your_module import YourModule

class TestYourModule:
    """Comprehensive test suite for YourModule."""
    
    def setup_method(self):
        """Set up test fixtures."""
        self.module = YourModule()
    
    def test_initialization(self):
        """Test module initializes correctly."""
        assert self.module.initialized is True
    
    def test_process_success(self):
        """Test successful processing."""
        result = self.module.process({"test": "data"})
        assert result["status"] == "success"
    
    def test_process_error_handling(self):
        """Test error handling."""
        result = self.module.process(None)
        assert result["status"] == "error"

Coverage Requirements

# Run tests with coverage
pytest modules/your_domain/your_module/ --cov=modules.your_domain.your_module.src --cov-report=term-missing

# Must achieve ≥90% coverage for WSP 5 compliance

🤖 Agent Integration

WRE Orchestration

Your module can be orchestrated by the WRE Core Engine:

# Register with orchestration triggers
from modules.wre_core.src.components.agentic_orchestrator.orchestration_context import OrchestrationTrigger

# Your module will be called during relevant orchestration workflows
# following the WSP 54 agent duties specification

Autonomous Capabilities

Modules can evolve into autonomous agents that:

  • Monitor their own health and performance
  • Self-update when improvements become available
  • Coordinate with other agents for complex workflows
  • Contribute to the recursive improvement of the ecosystem

💡 Contribution Guidelines

What to Build

High-Impact Areas:

  • Communication modules - Chat, video, voice processing
  • Platform integrations - Social media, productivity tools
  • AI intelligence - Natural language, decision making
  • Infrastructure - Monitoring, scaling, security
  • Economic tools - Bitcoin integration, payment processing

What We Need Most

  1. Bitcoin/Lightning Network integration modules
  2. Social media platform adapters (Twitter, LinkedIn, YouTube)
  3. AI agent coordination systems
  4. Testing and quality assurance tools
  5. Documentation and onboarding improvements

Contribution Process

  1. Choose your domain based on your skills and interests
  2. Study existing modules in that domain for patterns
  3. Use WSP 33 workflow for guided module creation
  4. Follow WSP 1-10 for all development standards
  5. Submit PR with comprehensive tests and documentation

🌍 Impact Focus

Remember the Mission

Every module you build contributes to:

  • Replacing extractive startups with regenerative FoundUps
  • Creating collaborative abundance instead of competitive scarcity
  • Building post-capitalist infrastructure for planetary healing
  • Ensuring AI serves everyone rather than just the wealthy

Quality Over Quantity

  • One excellent module is better than ten mediocre ones
  • Follow WSP protocols religiously - they ensure long-term sustainability
  • Build for 100-year lifespans - make it maintainable and upgradeable
  • Document everything - knowledge must be accessible to all

🎓 Learning Resources

Essential Reading

Code Examples

  • modules/wre_core/ - Complete reference implementation
  • modules/communication/livechat/ - Well-documented communication module
  • modules/ai_intelligence/rESP_o1o2/ - Advanced AI integration patterns

Community

  • GitHub Issues - Technical discussions and bug reports
  • GitHub Discussions - Design decisions and architectural questions
  • Wiki Pages - Comprehensive documentation and guides

🚀 Ready to Build the Future?

Your next commit could be the one that changes everything.

Start with a single module. Build for humanity. Transform the world.

Welcome to the revolution. 🌍✊

Clone this wiki locally