Adds AGENTS.md (clean-room and Bun rules), pointer files, agent permission configs, docs tree, the STaurtomation design spec (draft) and sanitized licensing/competitor research. Co-Authored-By: Claude Opus 5.5 <[email protected]>
33 lines
1.4 KiB
Markdown
33 lines
1.4 KiB
Markdown
# Architecture
|
|
|
|
How `STaurtomation` is built today. Update in the same commit as any structural change.
|
|
|
|
## Overview
|
|
No code exists yet. The target architecture is specified in `docs/specs/001-staurtomation.md` §4:
|
|
one Bun process serving the React editor, the REST/WebSocket API, scheduler and workflow engine;
|
|
separate language runners (Bun/TypeScript, Python first) that connect to the server over WebSocket,
|
|
receive jobs and stream results back. Replace this section with reality as modules land.
|
|
|
|
## Map
|
|
| Path | Responsibility |
|
|
|---|---|
|
|
| `docs/specs/` | Permanent specs; `001-staurtomation.md` is the product design |
|
|
| `docs/research/` | Sanitized licensing and competitor research (clean-room safe) |
|
|
| `docs/plans/` | Transient implementation plans |
|
|
|
|
## Data flow
|
|
Planned (spec §4.4): trigger → server enqueues execution → runner executes nodes on lists of items
|
|
→ per-node input/output persisted (subject to retention/redaction) → editor shows results.
|
|
|
|
## External dependencies
|
|
Planned: SQLite (single box) or PostgreSQL; optional Redis for HA; optional container runtime for
|
|
isolated job execution; optional S3-compatible storage for binary data.
|
|
|
|
## Invariants
|
|
- No code from n8n, Kestra, Windmill or Activepieces; no dependency on their packages (spec §3.2).
|
|
- No feature gated by edition, key, user count or payment.
|
|
- Imports never silently drop nodes or data.
|
|
|
|
## Known rough edges
|
|
None yet — see `docs/TODO.md`.
|