mirror of
https://github.com/sartography/spiff-arena.git
synced 2025-02-19 12:57:19 +00:00
963d62b323
* let us proof everything * proof and ventilate everything * restore removed content * add back in some headers * add back more headers * restore header * fix header * fix backend * restore two long files from main to avoid mangling * update edit_all for testing * fix docs * notes * more spacing --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
# Technical Overview
|
|
|
|
## Components
|
|
|
|
```mermaid
|
|
graph TD
|
|
subgraph spiff-arena
|
|
Backend
|
|
Frontend
|
|
end
|
|
subgraph Backend
|
|
subgraph SpiffWorkflow lib
|
|
end
|
|
end
|
|
subgraph Frontend
|
|
subgraph bpmn-js-spiffworkflow lib
|
|
end
|
|
end
|
|
Frontend -- uses REST API --> Backend
|
|
Backend -- delegates to --> C
|
|
Backend -- persists to --> DB
|
|
DB[(mysql/postgres)]
|
|
C[Connector Proxy]
|
|
```
|
|
|
|
SpiffArena is a system that allows users to build and execute BPMN diagrams.
|
|
It is composed of three applications, [spiffworkflow-frontend](frontend), [spiffworkflow-backend](backend), and, optionally, a [connector proxy](connector_proxy).
|
|
|
|
## Source code layout
|
|
|
|
From a source code perspective, there are three repositories that may be of interest:
|
|
|
|
* [spiff-arena](https://github.com/sartography/spiff-arena) - Includes spiffworkflow-frontend, spiffworkflow-backend, and connector-proxy-demo.
|
|
* [SpiffWorkflow](https://github.com/sartography/SpiffWorkflow) - The core SpiffWorkflow library, 10 years old, Python, awesome, [well-documented](https://spiffworkflow.readthedocs.io/).
|
|
* [bpmn-js-spiffworkflow](https://github.com/sartography/bpmn-js-spiffworkflow) - The frontend library that extends bpmn-js to work with SpiffWorkflow.
|