# Soleprint > Cada paso deja huella / Each step leaves a mark Development workflow and documentation platform. Run, test, and document everything in one place. ## Quick Start ```bash cd gen pip install -r requirements.txt python main.py # Visit http://localhost:12000 ``` ## Systems | | System | What it does | |---|--------|--------------| | πŸ’‰ | **Artery** | Connectors to external services (Jira, Slack, APIs) | | πŸ—ΊοΈ | **Atlas** | Actionable documentation (BDD, Gherkin, specs) | | πŸŽ›οΈ | **Station** | Tools, environments, test runners | ## Structure ``` spr/ β”œβ”€β”€ schema.json # Model definitions (source of truth) β”œβ”€β”€ config/ # Framework configuration β”œβ”€β”€ ctrl/ # Soleprint room ctrl β”‚ β”œβ”€β”€ artery/ # Connectors (versioned) β”œβ”€β”€ atlas/ # Documentation (versioned) β”œβ”€β”€ station/ # Tools (versioned) β”‚ └── tools/ β”‚ β”œβ”€β”€ generator/ # Generates models from schema β”‚ β”œβ”€β”€ datagen/ # Test data generation β”‚ └── tester/ # BDD/contract test runner β”‚ β”œβ”€β”€ data/ # JSON content β”œβ”€β”€ hub/ # Base files (main.py, dataloader, etc.) β”œβ”€β”€ gen/ # Runnable instance (symlinks + generated models) β”‚ └── mainroom/ # Orchestration: soleprint ↔ managed room β”œβ”€β”€ ctrl/ # Orchestration commands β”œβ”€β”€ sbwrapper/ # Sidebar wrapper UI β”œβ”€β”€ link/ # Adapters for managed apps └── soleprint/ # Docker configs ``` ## Components **Shared:** - **Room** - Environment configuration - **Depot** - Data storage **System-specific:** - **Vein** (Artery) - Single connector - **Template** (Atlas) - Doc pattern - **Tool** (Station) - Utility **Composed:** - **Pulse** = Vein + Room + Depot - **Book** = Template + Depot - **Desk** = Cabinet + Room + Depots ## Development ### Run locally ```bash cd gen python main.py ``` ### Regenerate models (one-time / rare) ```bash cd station/tools/generator python -m generators.orchestrator --output ../../../gen ``` ### Run with Docker (via mainroom) ```bash cd mainroom/soleprint docker compose up -d ``` ## Ports | Service | Port | |---------|------| | Hub (soleprint) | 12000 | | Artery | 12001 | | Atlas | 12002 | | Station | 12003 | ## Architecture ``` hub/ β†’ Versioned base files (main.py, dataloader) gen/ β†’ Runnable instance (symlinks to hub/ + systems) gen/models/ β†’ Generated once per client (like install) mainroom/ β†’ Orchestration layer β”œβ”€β”€ sbwrapper β†’ UI overlay for managed apps β”œβ”€β”€ link β†’ Data adapters (no modification to either side) └── soleprint β†’ Docker for soleprint services ``` ## Background Born from the friction of: - Testing requiring PRs on small teams - Documentation scattered across tools - Quick API connectors taking too long to set up - No self-contained environment to experiment freely Soleprint lets you run everything in isolation while building reusable pieces. ## License TBD --- *Built for small teams who need to move fast without breaking things.*