Files
govoplan-workflow/README.md
T

54 lines
2.4 KiB
Markdown

# GovOPlaN Workflow
<!-- govoplan-repository-type:start -->
**Repository type:** module (platform).
<!-- govoplan-repository-type:end -->
Optional visual authoring and inspection workspace for GovOPlaN Workflow
Engine.
This module owns the Workflow catalogue, native BPMN/graph editor, validation
and activation UI, immutable revision inspection, instance controls, and the
governed module-standard compare/override/reset experience. The headless
`govoplan-workflow-engine` package owns persistence, migrations, API routes,
runtime services, and module integration contracts.
For one compatibility release, Python imports below
`govoplan_workflow.backend` re-export their corresponding Workflow Engine
implementations. New module code must use Core's `workflow.*` capabilities or,
for engine implementation code, `govoplan_workflow_engine` directly.
See [the engine/editor split](docs/ENGINE_EDITOR_SPLIT.md) for the durable
ownership boundary.
See [the module concept](docs/CONCEPT.md) and
[BPMN interoperability contract](docs/BPMN_INTEROPERABILITY.md) for the shared
model retained by Workflow Engine.
The editor route, graph, decision, state, and accessibility mapping is recorded
in [the interface pattern audit](docs/INTERFACE_PATTERN_MIGRATION.md).
## Checks
```bash
/mnt/DATA/git/govoplan/.venv/bin/python -m unittest discover -s tests
cd webui && npm run typecheck
cd webui && npm run test:interface-pattern
```
## Git-source WebUI package
The repository root exposes `@govoplan/workflow-webui` for Git-tagged release
dependencies. It mirrors the owning `webui/package.json` version, public
TypeScript/CSS exports and peer requirements, with entry paths under
`webui/src`. Consumers provide the shared Core/React peers; the facade runs no
development or install scripts. The source archive contains `webui/src`, this
README and any repository license file. Run module development checks from `webui/`; Python
installation remains governed by `pyproject.toml`.
Das Repository stellt `@govoplan/workflow-webui` am Wurzelpfad für versionierte
Git-Abhängigkeiten bereit. Version, öffentliche TypeScript-/CSS-Exporte und
Peer-Anforderungen entsprechen `webui/package.json`; die Einstiegspfade liegen
unter `webui/src`. Gemeinsame Core-/React-Peers stellt die einbindende Anwendung
bereit. Die Fassade führt keine Entwicklungs- oder Installationsskripte aus.
Entwicklungsprüfungen bleiben in `webui/`, die Python-Installation weiterhin in
`pyproject.toml` definiert.