1.1 changes
This commit is contained in:
50
README.md
50
README.md
@@ -7,9 +7,14 @@ Development workflow and documentation platform. Run, test, and document everyth
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Build dev environment
|
||||
python build.py dev
|
||||
|
||||
# Run
|
||||
cd gen
|
||||
pip install -r requirements.txt
|
||||
python main.py
|
||||
python3 -m venv .venv
|
||||
.venv/bin/pip install -r requirements.txt
|
||||
.venv/bin/python run.py # Single-port bare-metal dev
|
||||
# Visit http://localhost:12000
|
||||
```
|
||||
|
||||
@@ -17,6 +22,7 @@ python main.py
|
||||
|
||||
| | System | What it does |
|
||||
|---|--------|--------------|
|
||||
| 👣 | **Soleprint** | Core coordinator, routing, landing page |
|
||||
| 💉 | **Artery** | Connectors to external services (Jira, Slack, APIs) |
|
||||
| 🗺️ | **Atlas** | Actionable documentation (BDD, Gherkin, specs) |
|
||||
| 🎛️ | **Station** | Tools, environments, test runners |
|
||||
@@ -26,25 +32,29 @@ python main.py
|
||||
```
|
||||
spr/
|
||||
├── schema.json # Model definitions (source of truth)
|
||||
├── config/ # Framework configuration
|
||||
├── ctrl/ # Soleprint room ctrl
|
||||
├── cfg/ # Framework configuration
|
||||
│ ├── soleprint.config.json
|
||||
│ └── amar/ # Room-specific configs
|
||||
│
|
||||
├── soleprint/ # Core coordinator (versioned)
|
||||
│ ├── main.py # Multi-port entry point
|
||||
│ ├── run.py # Single-port bare-metal dev
|
||||
│ └── dataloader/
|
||||
│
|
||||
├── artery/ # Connectors (versioned)
|
||||
├── atlas/ # Documentation (versioned)
|
||||
├── station/ # Tools (versioned)
|
||||
│ └── tools/
|
||||
│ ├── generator/ # Generates models from schema
|
||||
│ ├── modelgen/ # Generates models from config
|
||||
│ ├── 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)
|
||||
├── gen/ # Runnable instance (symlinks + generated)
|
||||
│
|
||||
└── mainroom/ # Orchestration: soleprint ↔ managed room
|
||||
├── ctrl/ # Orchestration commands
|
||||
├── sbwrapper/ # Sidebar wrapper UI
|
||||
├── link/ # Adapters for managed apps
|
||||
└── soleprint/ # Docker configs
|
||||
```
|
||||
|
||||
@@ -66,16 +76,14 @@ spr/
|
||||
|
||||
## Development
|
||||
|
||||
### Run locally
|
||||
### Build and run
|
||||
```bash
|
||||
cd gen
|
||||
python main.py
|
||||
```
|
||||
python build.py dev # Soleprint only
|
||||
python build.py dev --cfg amar # With amar room config
|
||||
|
||||
### Regenerate models (one-time / rare)
|
||||
```bash
|
||||
cd station/tools/generator
|
||||
python -m generators.orchestrator --output ../../../gen
|
||||
cd gen
|
||||
.venv/bin/python run.py # Bare-metal single-port
|
||||
.venv/bin/python main.py # Multi-port (production-like)
|
||||
```
|
||||
|
||||
### Run with Docker (via mainroom)
|
||||
@@ -88,7 +96,7 @@ docker compose up -d
|
||||
|
||||
| Service | Port |
|
||||
|---------|------|
|
||||
| Hub (soleprint) | 12000 |
|
||||
| Soleprint | 12000 |
|
||||
| Artery | 12001 |
|
||||
| Atlas | 12002 |
|
||||
| Station | 12003 |
|
||||
@@ -96,13 +104,13 @@ docker compose up -d
|
||||
## Architecture
|
||||
|
||||
```
|
||||
hub/ → Versioned base files (main.py, dataloader)
|
||||
gen/ → Runnable instance (symlinks to hub/ + systems)
|
||||
soleprint/ → Versioned core files (main.py, run.py, dataloader)
|
||||
gen/ → Runnable instance (symlinks to soleprint/ + systems)
|
||||
gen/models/ → Generated once per client (like install)
|
||||
cfg/ → Configuration (copied to gen/cfg/)
|
||||
|
||||
mainroom/ → Orchestration layer
|
||||
├── sbwrapper → UI overlay for managed apps
|
||||
├── link → Data adapters (no modification to either side)
|
||||
└── soleprint → Docker for soleprint services
|
||||
```
|
||||
|
||||
@@ -122,4 +130,4 @@ TBD
|
||||
|
||||
---
|
||||
|
||||
*Built for small teams who need to move fast without breaking things.*
|
||||
*Built for small teams who need to move fast without breaking things.*
|
||||
|
||||
Reference in New Issue
Block a user