soleprint init commit

This commit is contained in:
buenosairesam
2025-12-24 05:38:37 -03:00
commit 329c401ff5
96 changed files with 11564 additions and 0 deletions

96
README.md Normal file
View File

@@ -0,0 +1,96 @@
# 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
├── artery/ # Connectors (source)
├── atlas/ # Documentation (source)
├── station/ # Tools (source)
│ └── tools/
│ ├── generator/ # Generates models & structure
│ ├── datagen/ # Test data generation
│ └── tester/ # Test runner
├── data/ # Content (JSON)
└── gen/ # Runnable instance (run from here)
```
## 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 (when schema.json changes)
```bash
cd station/tools/generator
python -m generators.orchestrator --output ../../../gen
```
## Ports
| Service | Port |
|---------|------|
| Hub | 12000 |
| Artery | 12001 |
| Atlas | 12002 |
| Station | 12003 |
## 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.*