major restructure
This commit is contained in:
24
README.md
24
README.md
@@ -1,7 +1,5 @@
|
||||
# Soleprint
|
||||
|
||||
> Cada paso deja huella / Each step leaves a mark
|
||||
|
||||
Development workflow platform. Run, test, and document everything in one place.
|
||||
|
||||
## Quick Start
|
||||
@@ -23,16 +21,16 @@ cd gen/amar && .venv/bin/python run.py
|
||||
```bash
|
||||
# Build
|
||||
python build.py dev # → gen/standalone/
|
||||
python build.py dev --cfg amar # → gen/amar/
|
||||
python build.py dev --cfg <managed># → gen/<managed>/
|
||||
python build.py dev --all # → both
|
||||
|
||||
# ctrl scripts
|
||||
./ctrl/build.sh # Build standalone
|
||||
./ctrl/build.sh amar # Build amar
|
||||
./ctrl/build.sh <managed> # Build <managed>
|
||||
./ctrl/build.sh --all # Build all
|
||||
|
||||
./ctrl/start.sh # Start standalone (Docker)
|
||||
./ctrl/start.sh amar # Start amar
|
||||
./ctrl/start.sh <managed> # Start amar
|
||||
./ctrl/start.sh -d # Detached
|
||||
./ctrl/stop.sh # Stop
|
||||
./ctrl/logs.sh # View logs
|
||||
@@ -42,12 +40,12 @@ python build.py dev --all # → both
|
||||
|
||||
1. Create room config directory:
|
||||
```bash
|
||||
mkdir -p cfg/clientx
|
||||
mkdir -p cfg/<managed>
|
||||
```
|
||||
|
||||
2. Add required files:
|
||||
```
|
||||
cfg/clientx/
|
||||
cfg/<managed>/
|
||||
├── .env.example # Environment template
|
||||
├── docker-compose.yml # Room services (optional)
|
||||
├── databrowse/depot/ # Database schemas (optional)
|
||||
@@ -61,8 +59,8 @@ cfg/clientx/
|
||||
|
||||
3. Build and run:
|
||||
```bash
|
||||
python build.py dev --cfg clientx
|
||||
./ctrl/start.sh clientx
|
||||
python build.py dev --cfg <managed>
|
||||
./ctrl/start.sh <managed>
|
||||
```
|
||||
|
||||
## Systems
|
||||
@@ -70,9 +68,9 @@ python build.py dev --cfg clientx
|
||||
| | System | What it does |
|
||||
|---|--------|--------------|
|
||||
| 👣 | **Soleprint** | Core coordinator, routing, landing page |
|
||||
| 💉 | **Artery** | Connectors to external services (Jira, Slack, Google) |
|
||||
| 🗺️ | **Atlas** | Actionable documentation (BDD, Gherkin, specs) |
|
||||
| 🎛️ | **Station** | Tools (modelgen, tester) and monitors (databrowse) |
|
||||
| 💉 | **Artery** | Connectors to external services |
|
||||
| 🗺️ | **Atlas** | Actionable documentation |
|
||||
| 🎛️ | **Station** | Tools and monitors |
|
||||
|
||||
## Structure
|
||||
|
||||
@@ -146,5 +144,3 @@ Shunt ── Fake connector for testing
|
||||
| google | OAuth2 |
|
||||
|
||||
---
|
||||
|
||||
*Built for small teams who need to move fast without breaking things.*
|
||||
|
||||
Reference in New Issue
Block a user